CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", "operations": { "ActivateOrganizationsAccess": "Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
", - "ActivateType": "Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "ActivateType": "Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", "CancelUpdateStack": "Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
", "DeleteStackInstances": "Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
", "DeleteStackSet": "Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
", - "DeregisterType": "Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
", + "DeregisterType": "Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType .
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide.
", "DescribeChangeSet": "Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.
", "DescribeChangeSetHooks": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
", "DescribeGeneratedTemplate": "Describes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate API action or the update of a generated template started with an UpdateGeneratedTemplate API action.
Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.
Returns information about a CloudFormation extension publisher.
If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
Returns information about a CloudFormation extension publisher.
If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
Describes details of a resource scan.
", "DescribeStackDriftDetectionStatus": "Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
Returns a list of registration tokens for the specified extension(s).
", "ListTypeVersions": "Returns summary information about the versions of an extension.
", "ListTypes": "Returns summary information about extension that have been registered with CloudFormation.
", - "PublishType": "Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", + "PublishType": "Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher .
Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
", "RegisterPublisher": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
", - "RegisterType": "Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
Validating the extension schema.
Determining which handlers, if any, have been specified for the extension.
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "RegisterType": "Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
Validating the extension schema.
Determining which handlers, if any, have been specified for the extension.
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.
CREATE_COMPLETE
UPDATE_COMPLETE
UPDATE_ROLLBACK_COMPLETE
IMPORT_COMPLETE
IMPORT_ROLLBACK_COMPLETE
Sets a stack policy for a specified stack.
", - "SetTypeConfiguration": "Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType . For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
", "SignalResource": "Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.
Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
", - "TestType": "Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
For resource types, this includes passing all contracts tests defined for the type.
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using TestType, you can pass the returned TypeVersionArn into DescribeType to monitor the current test status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
For resource types, this includes passing all contracts tests defined for the type.
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType .
Once you've initiated testing on an extension using TestType, you can pass the returned TypeVersionArn into DescribeType to monitor the current test status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of the update to the generated template using the DescribeGeneratedTemplate API action.
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
", - "UpdateStackInstances": "Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances .
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
", "UpdateTerminationProtection": "Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
", "ValidateTemplate": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.
" @@ -292,15 +292,15 @@ "Capabilities": { "base": null, "refs": { - "CreateChangeSetInput$Capabilities": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
", "GetTemplateSummaryOutput$Capabilities": "The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
", "Stack$Capabilities": "The capabilities allowed in the stack.
", "StackSet$Capabilities": "The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.
", - "UpdateStackInput$Capabilities": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Only one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Only one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
" } }, @@ -518,7 +518,7 @@ "ConfigurationSchema": { "base": null, "refs": { - "DescribeTypeOutput$ConfigurationSchema": "A JSON string that represent the current configuration data for the extension in this account and Region.
To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" + "DescribeTypeOutput$ConfigurationSchema": "A JSON string that represent the current configuration data for the extension in this account and Region.
To set the configuration data for an extension, use SetTypeConfiguration . For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
The description found within the template.
" } }, + "DetailedStatus": { + "base": null, + "refs": { + "Stack$DetailedStatus": "The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.
An optional field containing information about the detailed status of the stack event.
CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.
VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.
Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.
Default: false
Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.
True - if the stack creation fails, do nothing. This is equivalent to specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.
False - if the stack creation fails, roll back the stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.
Default: True
Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.
True - if the stack creation fails, do nothing. This is equivalent to specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.
False - if the stack creation fails, roll back the stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.
Default: True
Boolean to enable or disable rollback on stack creation failures:
true: disable rollback.
false: enable rollback.
Preserve the state of previously provisioned resources when an operation fails.
Default: False
Contains logging configuration information for an extension.
", "refs": { "ActivateTypeInput$LoggingConfig": "Contains logging configuration information for an extension.
", - "DescribeTypeOutput$LoggingConfig": "Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.
Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType .
Specifies logging configuration information for an extension.
" } }, @@ -1676,7 +1683,7 @@ "MonitoringTimeInMinutes": { "base": null, "refs": { - "RollbackConfiguration$MonitoringTimeInMinutes": "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.
The default is 0 minutes.
If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.
" + "RollbackConfiguration$MonitoringTimeInMinutes": "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.
The default is 0 minutes.
If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack , for example) as necessary.
If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.
" } }, "NameAlreadyExistsException": { @@ -1773,8 +1780,8 @@ "OnStackFailure": { "base": null, "refs": { - "CreateChangeSetInput$OnStackFailure": "Determines what action will be taken if stack creation fails. If this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to be deleted.
Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
Determines what action will be taken if stack creation fails. If this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to be deleted.
Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
", - "StackInstanceSummary$OrganizationalUnitId": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
", - "StackSetOperationResultSummary$OrganizationalUnitId": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
" + "StackInstance$OrganizationalUnitId": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
", "ImportStacksToStackSetInput$OrganizationalUnitIds": "The list of OU ID's to which the stacks being imported has to be mapped as deployment target.
", - "StackSet$OrganizationalUnitIds": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
" + "StackSet$OrganizationalUnitIds": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.
A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
A list of stack set parameters whose values you want to override in the selected stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
", + "CreateStackInput$Parameters": "A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
A list of stack set parameters whose values you want to override in the selected stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
The input parameters for the stack set template.
", - "DescribeChangeSetOutput$Parameters": "A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
A list of Parameter structures that specify input parameters.
A list of Parameter structures.
A list of parameters from the stack set template whose values have been overridden in this stack instance.
", "StackSet$Parameters": "A list of input parameters for a stack set.
", - "UpdateStackInput$Parameters": "A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
A list of input parameters whose values you want to update for the specified stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
A list of input parameters whose values you want to update for the specified stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
A list of input parameters for the stack set template.
" } }, @@ -2476,13 +2483,13 @@ "base": null, "refs": { "ResourceChange$ResourceType": "The type of CloudFormation resource, such as AWS::S3::Bucket.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types in the CloudFormation User Guide
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types in the CloudFormation User Guide
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
The template resource type of the target resources, such as AWS::S3::Bucket.
The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the CloudFormation User Guide.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support In the CloudFormation User Guide
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide.
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
", "StackInstanceResourceDriftsSummary$ResourceType": "Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
", "StackResource$ResourceType": "Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
", @@ -2610,7 +2617,7 @@ "base": null, "refs": { "ActivateTypeInput$ExecutionRoleArn": "The name of the IAM execution role to use to activate the extension.
", - "DescribeTypeOutput$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.
If the registered extension calls any Amazon Web Services APIs, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
", + "DescribeTypeOutput$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType .
If the registered extension calls any Amazon Web Services APIs, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
", "LoggingConfig$LogRoleArn": "The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
", "RegisterTypeInput$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principal (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.
" } @@ -2840,7 +2847,7 @@ "StackInstanceDetailedStatus": { "base": null, "refs": { - "StackInstanceComprehensiveStatus$DetailedStatus": " CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
PENDING: The operation in the specified account and Region has yet to start.
RUNNING: The operation in the specified account and Region is currently in progress.
SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region has been skipped because the account was suspended at the time of the operation.
SUCCEEDED: The operation in the specified account and Region completed successfully.
CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
FAILED_IMPORT: The import of the stack instance in the specified account and Region failed and left the stack in an unstable state. Once the issues causing the failure are fixed, the import operation can be retried. If enough stack set operations fail in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
PENDING: The operation in the specified account and Region has yet to start.
RUNNING: The operation in the specified account and Region is currently in progress.
SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region has been skipped because the account was suspended at the time of the operation.
SUCCEEDED: The operation in the specified account and Region completed successfully.
The status of the stack instance, in terms of its synchronization with its associated stack set.
INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
CURRENT: The stack is currently up to date with the stack set.
The status of the stack instance, in terms of its synchronization with its associated stack set.
INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
CURRENT: The stack is currently up to date with the stack set.
The status of the stack instance, in terms of its synchronization with its associated stack set.
INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, look at the DetailedStatus member in the StackInstanceSummary member that is a peer to this Status member.
OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
CURRENT: The stack is currently up to date with the stack set.
The status of the stack instance, in terms of its synchronization with its associated stack set.
INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.
OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
CURRENT: The stack is currently up to date with the stack set.
Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
" + "UpdateStackInput$StackPolicyDuringUpdateURL": "Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
" } }, "StackPolicyURL": { "base": null, "refs": { - "CreateStackInput$StackPolicyURL": "Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
" + "CreateStackInput$StackPolicyURL": "Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for an Amazon S3 bucket must start with https://. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
" } }, "StackResource": { @@ -3444,14 +3451,14 @@ "TemplateURL": { "base": null, "refs": { - "CreateChangeSetInput$TemplateURL": "The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified.
Conditional: You must specify only TemplateBody or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only TemplateBody or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
", - "EstimateTemplateCostInput$TemplateURL": "Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
The time that the resource scan was started.
", "DescribeResourceScanOutput$EndTime": "The time that the resource scan was finished.
", "DescribeStackDriftDetectionStatusOutput$Timestamp": "Time at which the stack drift detection operation was initiated.
", - "DescribeTypeOutput$LastUpdated": "When the specified extension version was registered. This applies only to:
Private extensions you have registered in your account. For more information, see RegisterType.
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
When the specified extension version was registered. This applies only to:
Private extensions you have registered in your account. For more information, see RegisterType .
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType .
When the specified private extension version was registered or activated in your account.
", "ResourceScanSummary$StartTime": "The time that the resource scan was started.
", "ResourceScanSummary$EndTime": "The time that the resource scan was finished.
", @@ -3517,7 +3524,7 @@ "StackSetOperationSummary$EndTimestamp": "The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
", "StackSetSummary$LastDriftCheckTimestamp": "Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection hasn't yet been performed.
When the configuration data was last updated for this extension.
If a configuration hasn't been set for a specified extension, CloudFormation returns null.
When the specified extension version was registered. This applies only to:
Private extensions you have registered in your account. For more information, see RegisterType.
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
For all other extension types, CloudFormation returns null.
When the specified extension version was registered. This applies only to:
Private extensions you have registered in your account. For more information, see RegisterType .
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType .
For all other extension types, CloudFormation returns null.
When the version was registered.
" } }, @@ -3560,7 +3567,7 @@ "Type": { "base": null, "refs": { - "RollbackTrigger$Type": "The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
" + "RollbackTrigger$Type": "The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary information.
Conditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) assigned to the public extension upon publication.
", - "SetTypeConfigurationInput$TypeArn": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you activate the type in this account and Region. For private extensions, this will be the ARN assigned when you register the type in this account and Region.
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.
", + "SetTypeConfigurationInput$TypeArn": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.
", "TestTypeInput$Arn": "The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify Arn, or TypeName and Type.
The Amazon Resource Name (ARN) of the extension.
", - "TypeConfigurationDetails$TypeArn": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you activate the type in this account and Region. For private extensions, this will be the ARN assigned when you register the type in this account and Region.
", - "TypeConfigurationIdentifier$TypeArn": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you activate the type in this account and Region. For private extensions, this will be the ARN assigned when you register the type in this account and Region.
", + "TypeConfigurationDetails$TypeArn": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.
The Amazon Resource Name (ARN) of the extension.
", "TypeVersionSummary$Arn": "The Amazon Resource Name (ARN) of the extension version.
" } @@ -3586,7 +3593,7 @@ "TypeConfiguration": { "base": null, "refs": { - "SetTypeConfigurationInput$Configuration": "The configuration data for the extension, in this account and Region.
The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.
The configuration data for the extension, in this account and Region.
The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of DescribeType . For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.
A JSON string specifying the configuration data for the extension, in this account and Region.
If a configuration hasn't been set for a specified extension, CloudFormation returns {}.
The type name of the extension, in this account and Region. If you specified a type name alias when enabling the extension, use the type name alias.
Conditional: You must specify either Arn, or TypeName and Type.
The name of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.
", + "DescribeTypeOutput$TypeName": "The name of the extension.
If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType .
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
The name of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
The name of the extension for which you want version summary information.
Conditional: You must specify either TypeName and Type, or Arn.
The name of the extension to test.
Conditional: You must specify Arn, or TypeName and Type.
The name of the extension.
", "TypeConfigurationIdentifier$TypeName": "The name of the extension type to which this configuration applies.
", - "TypeSummary$TypeName": "The name of the extension.
If you specified a TypeNameAlias when you activate this extension in your account and Region, CloudFormation considers that alias as the type name.
The name of the extension.
If you specified a TypeNameAlias when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
The name of the extension.
" } @@ -3721,10 +3728,10 @@ "refs": { "DeregisterTypeInput$VersionId": "The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
", "DescribeTypeInput$VersionId": "The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.
The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
", + "DescribeTypeOutput$DefaultVersionId": "The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType .
To set the default version of an extension, use SetTypeDefaultVersion.
", "SetTypeDefaultVersionInput$VersionId": "The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
", "TestTypeInput$VersionId": "The version of the extension to test.
You can specify the version id with either Arn, or with TypeName and Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.
", - "TypeSummary$DefaultVersionId": "The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
", + "TypeSummary$DefaultVersionId": "The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType .
To set the default version of an extension, use SetTypeDefaultVersion.
", "TypeVersionSummary$VersionId": "The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it's registered.
" } }, diff --git a/models/apis/fsx/2018-03-01/api-2.json b/models/apis/fsx/2018-03-01/api-2.json index d05e82a807..af4f10c425 100644 --- a/models/apis/fsx/2018-03-01/api-2.json +++ b/models/apis/fsx/2018-03-01/api-2.json @@ -2603,7 +2603,7 @@ }, "HAPairs":{ "type":"integer", - "max":6, + "max":12, "min":1 }, "IncludeShared":{"type":"boolean"}, diff --git a/models/apis/fsx/2018-03-01/docs-2.json b/models/apis/fsx/2018-03-01/docs-2.json index ba2ceb3612..59ce93b717 100644 --- a/models/apis/fsx/2018-03-01/docs-2.json +++ b/models/apis/fsx/2018-03-01/docs-2.json @@ -29,7 +29,7 @@ "DescribeFileCaches": "Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value.
The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified.
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
", "DescribeFileSystems": "Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide.
", + "DescribeSharedVpcConfiguration": "Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets.
", "DescribeSnapshots": "Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.
The order of snapshots returned in the response of one DescribeSnapshots call and the order of backups returned across the responses of a multi-call iteration is unspecified.
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
", "DescribeVolumes": "Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
", @@ -448,7 +448,7 @@ } }, "CreateAggregateConfiguration": { - "base": "Used to specify the configuration options for a volume's storage aggregate or aggregates.
", + "base": "Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
", "refs": { "CreateOntapVolumeConfiguration$AggregateConfiguration": "Use to specify configuration options for a volume’s storage aggregate or aggregates.
" } @@ -598,9 +598,9 @@ } }, "CreateSvmActiveDirectoryConfiguration": { - "base": "The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.
", + "base": "The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.
", "refs": { - "CreateStorageVirtualMachineRequest$ActiveDirectoryConfiguration": "Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS client accessing the file system.
" + "CreateStorageVirtualMachineRequest$ActiveDirectoryConfiguration": "Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system.
" } }, "CreateVolumeFromBackupRequest": { @@ -1134,7 +1134,7 @@ "DiskIopsConfigurationMode": { "base": null, "refs": { - "DiskIopsConfiguration$Mode": "Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, , or if it using a USER_PROVISIONED value.
Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.
A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false. If it's set to true, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.
A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
", - "CreateOntapVolumeConfiguration$StorageEfficiencyEnabled": "Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. This parameter is required.
", + "CreateOntapVolumeConfiguration$StorageEfficiencyEnabled": "Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
StorageEfficiencyEnabled is required when creating a RW volume (OntapVolumeType set to RW).
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
", "CreateOpenZFSVolumeConfiguration$CopyTagsToSnapshots": "A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.
For more information, see SnapLock audit log volumes.
", @@ -1537,14 +1537,14 @@ "HAPairs": { "base": null, "refs": { - "CreateFileSystemOntapConfiguration$HAPairs": "Specifies how many high-availability (HA) pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of HAPairs is less than 1 or greater than 6.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of HAPairs is less than 1 or greater than 6.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Set to false (default) if you want to only see the snapshots in your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.
Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.
Specifies the type of volume you are creating. Valid values are the following:
RW specifies a read/write volume. RW is the default.
DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
" + "CreateOntapVolumeConfiguration$OntapVolumeType": "Specifies the type of volume you are creating. Valid values are the following:
RW specifies a read/write volume. RW is the default.
DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "IntegerNoMax": { "base": null, "refs": { - "OpenZFSUserOrGroupQuota$Id": "The ID of the user or group.
", - "OpenZFSUserOrGroupQuota$StorageCapacityQuotaGiB": "The amount of storage that the user or group can use in gibibytes (GiB).
", + "OpenZFSUserOrGroupQuota$Id": "The ID of the user or group that the quota applies to.
", + "OpenZFSUserOrGroupQuota$StorageCapacityQuotaGiB": "The user or group's storage quota, in gibibytes (GiB).
", "OpenZFSVolumeConfiguration$StorageCapacityReservationGiB": "The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
", "OpenZFSVolumeConfiguration$StorageCapacityQuotaGiB": "The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
" } @@ -2035,20 +2035,20 @@ "OpenZFSQuotaType": { "base": null, "refs": { - "OpenZFSUserOrGroupQuota$Type": "A value that specifies whether the quota applies to a user or group.
" + "OpenZFSUserOrGroupQuota$Type": "Specifies whether the quota applies to a user or group.
" } }, "OpenZFSUserAndGroupQuotas": { "base": null, "refs": { - "CreateOpenZFSVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
", + "CreateOpenZFSVolumeConfiguration$UserAndGroupQuotas": "Configures how much storage users and groups can use on the volume.
", "OpenZFSCreateRootVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
", "OpenZFSVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
", "UpdateOpenZFSVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
" } }, "OpenZFSUserOrGroupQuota": { - "base": "The configuration for how much storage a user or group can use on the volume.
", + "base": "Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide.
", "refs": { "OpenZFSUserAndGroupQuotas$member": null } @@ -2261,7 +2261,7 @@ "RouteTableIds": { "base": null, "refs": { - "CreateFileSystemOntapConfiguration$RouteTableIds": "(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
", + "CreateFileSystemOntapConfiguration$RouteTableIds": "(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
", "OntapFileSystemConfiguration$RouteTableIds": "(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
", "OpenZFSFileSystemConfiguration$RouteTableIds": "(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
", @@ -2291,13 +2291,13 @@ "refs": { "CreateFileCacheRequest$SecurityGroupIds": "A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
", "CreateFileSystemFromBackupRequest$SecurityGroupIds": "A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
" + "CreateFileSystemRequest$SecurityGroupIds": "A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
For more information, see Volume security style in the FSx for ONTAP User Guide.
", "OntapVolumeConfiguration$SecurityStyle": "The security style for the volume, which can be UNIX, NTFS, or MIXED.
The security style for the volume, which can be UNIX, NTFS, or MIXED.
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
", + "CreateOntapVolumeConfiguration$SnapshotPolicy": "Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
", "OntapVolumeConfiguration$SnapshotPolicy": "Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
", "UpdateOntapVolumeConfiguration$SnapshotPolicy": "Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
" } @@ -2485,7 +2485,7 @@ "refs": { "CreateFileCacheRequest$StorageCapacity": "The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
", "CreateFileSystemFromBackupRequest$StorageCapacity": "Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.
If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType, as follows:
For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maxium is calculated as 524,288 * HAPairs..
FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType, as follows:
For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.
FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
The storage capacity of the cache in gibibytes (GiB).
", "FileCacheCreating$StorageCapacity": "The storage capacity of the cache in gibibytes (GiB).
", "FileSystem$StorageCapacity": "The storage capacity of the file system in gibibytes (GiB).
Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.
The security style of the root volume of the SVM. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
The security style of the root volume of the SVM. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
NTFS if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account.
MIXED This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
The security style of the root volume of the SVM.
" } }, @@ -2714,7 +2714,7 @@ "DeleteVolumeOntapConfiguration$FinalBackupTags": null, "DeleteVolumeOntapResponse$FinalBackupTags": null, "FileCacheCreating$Tags": null, - "FileSystem$Tags": "The tags to associate with the file system. For more information, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
", + "FileSystem$Tags": "The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.
", "ListTagsForResourceResponse$Tags": "A list of tags on the resource.
", "Snapshot$Tags": null, "StorageVirtualMachine$Tags": null, @@ -2740,9 +2740,9 @@ "ThroughputCapacityPerHAPair": { "base": null, "refs": { - "CreateFileSystemOntapConfiguration$ThroughputCapacityPerHAPair": "Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 6).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 6).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 6).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.
This field and ThroughputCapacity are the same for scale-up file systems powered by one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2 file systems, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Specifies the size of the volume, in megabytes (MB), that you are creating.
", + "CreateOntapVolumeConfiguration$SizeInMegabytes": "Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
The configured size of the volume, in megabytes (MBs).
", "UpdateOntapVolumeConfiguration$SizeInMegabytes": "Specifies the size of the volume in megabytes.
" } @@ -2977,7 +2977,7 @@ "VolumeCapacityBytes": { "base": null, "refs": { - "CreateOntapVolumeConfiguration$SizeInBytes": "The configured size of the volume, in bytes.
", + "CreateOntapVolumeConfiguration$SizeInBytes": "Specifies the configured size of the volume, in bytes.
", "OntapVolumeConfiguration$SizeInBytes": "The configured size of the volume, in bytes.
", "UpdateOntapVolumeConfiguration$SizeInBytes": "The configured size of the volume, in bytes.
" } @@ -3070,7 +3070,7 @@ "VolumeStyle": { "base": null, "refs": { - "CreateOntapVolumeConfiguration$VolumeStyle": "Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
", + "CreateOntapVolumeConfiguration$VolumeStyle": "Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
", "OntapVolumeConfiguration$VolumeStyle": "Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
" } }, diff --git a/models/apis/organizations/2016-11-28/api-2.json b/models/apis/organizations/2016-11-28/api-2.json index 8b92948808..e92a4897b0 100644 --- a/models/apis/organizations/2016-11-28/api-2.json +++ b/models/apis/organizations/2016-11-28/api-2.json @@ -2422,7 +2422,6 @@ }, "PolicyContent":{ "type":"string", - "max":1000000, "min":1, "pattern":"[\\s\\S]*" }, @@ -2653,7 +2652,8 @@ "members":{ "Message":{"shape":"ExceptionMessage"} }, - "exception":true + "exception":true, + "fault":true }, "ServicePrincipal":{ "type":"string", diff --git a/models/apis/organizations/2016-11-28/docs-2.json b/models/apis/organizations/2016-11-28/docs-2.json index b6488cd27d..c49dee37de 100644 --- a/models/apis/organizations/2016-11-28/docs-2.json +++ b/models/apis/organizations/2016-11-28/docs-2.json @@ -1114,7 +1114,7 @@ "refs": { "DeleteOrganizationalUnitRequest$OrganizationalUnitId": "The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
", "DescribeOrganizationalUnitRequest$OrganizationalUnitId": "The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
", - "OrganizationalUnit$Id": "The unique identifier (ID) associated with this OU.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
", + "OrganizationalUnit$Id": "The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
", "UpdateOrganizationalUnitRequest$OrganizationalUnitId": "The unique identifier (ID) of the OU that you want to rename. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
" } }, @@ -1414,7 +1414,7 @@ "refs": { "DisablePolicyTypeRequest$RootId": "The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListRoots operation.
The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lowercase letters or digits.
", "EnablePolicyTypeRequest$RootId": "The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the ListRoots operation.
The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lowercase letters or digits.
", - "Root$Id": "The unique identifier (ID) for the root.
The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lowercase letters or digits.
" + "Root$Id": "The unique identifier (ID) for the root. The ID is unique to the organization only.
The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lowercase letters or digits.
" } }, "RootName": { diff --git a/service/cloudformation/api.go b/service/cloudformation/api.go index 9c084055c3..c589879448 100644 --- a/service/cloudformation/api.go +++ b/service/cloudformation/api.go @@ -9600,7 +9600,8 @@ type CreateChangeSetInput struct { // The location of the file that contains the revised template. The URL must // point to a template (max size: 460,800 bytes) that's located in an Amazon // S3 bucket or a Systems Manager document. CloudFormation generates the change - // set by comparing this template with the stack that you specified. + // set by comparing this template with the stack that you specified. The location + // for an Amazon S3 bucket must start with https://. // // Conditional: You must specify only TemplateBody or TemplateURL. TemplateURL *string `min:"1" type:"string"` @@ -9989,7 +9990,7 @@ type CreateStackInput struct { // specify either of these capabilities, CloudFormation returns an InsufficientCapabilities // error. If your stack template contains these resources, we recommend that // you review all permissions associated with them and edit their permissions - // if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) + // if necessary. AWS::IAM::AccessKey AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) // AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) // AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) // AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) @@ -10133,8 +10134,8 @@ type CreateStackInput struct { // Location of a file containing the stack policy. The URL must point to a policy // (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. - // You can specify either the StackPolicyBody or the StackPolicyURL parameter, - // but not both. + // The location for an Amazon S3 bucket must start with https://. You can specify + // either the StackPolicyBody or the StackPolicyURL parameter, but not both. StackPolicyURL *string `min:"1" type:"string"` // Key-value pairs to associate with this stack. CloudFormation also propagates @@ -10154,7 +10155,8 @@ type CreateStackInput struct { // Location of file containing the template body. The URL must point to a template // (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems // Manager document. For more information, go to the Template anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the CloudFormation User Guide. + // in the CloudFormation User Guide. The location for an Amazon S3 bucket must + // start with https://. // // Conditional: You must specify either the TemplateBody or the TemplateURL // parameter, but not both. @@ -15046,7 +15048,8 @@ type EstimateTemplateCostInput struct { // Location of file containing the template body. The URL must point to a template // that's located in an Amazon S3 bucket or a Systems Manager document. For // more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the CloudFormation User Guide. + // in the CloudFormation User Guide. The location for an Amazon S3 bucket must + // start with https://. // // Conditional: You must pass TemplateURL or TemplateBody. If both are passed, // only TemplateBody is used. @@ -15713,7 +15716,8 @@ type GetTemplateSummaryInput struct { // (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems // Manager document. For more information about templates, see Template anatomy // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the CloudFormation User Guide. + // in the CloudFormation User Guide. The location for an Amazon S3 bucket must + // start with https://. // // Conditional: You must specify only one of the following parameters: StackName, // StackSetName, TemplateBody, or TemplateURL. @@ -19942,7 +19946,7 @@ type ResourceDefinition struct { ResourceIdentifier map[string]*string `min:"1" type:"map" required:"true"` // The type of the resource, such as AWS::DynamoDB::Table. For the list of supported - // resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-supported-resources.html) + // resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) // in the CloudFormation User Guide // // ResourceType is a required field @@ -20048,7 +20052,7 @@ type ResourceDetail struct { ResourceStatusReason *string `type:"string"` // The type of the resource, such as AWS::DynamoDB::Table. For the list of supported - // resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-supported-resources.html) + // resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) // In the CloudFormation User Guide ResourceType *string `min:"1" type:"string"` @@ -20715,7 +20719,7 @@ type ScannedResource struct { ResourceIdentifier map[string]*string `type:"map"` // The type of the resource, such as AWS::DynamoDB::Table. For the list of supported - // resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-supported-resources.html) + // resources, see Resource type support (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) // In the CloudFormation User Guide ResourceType *string `min:"1" type:"string"` } @@ -20774,8 +20778,8 @@ type ScannedResourceIdentifier struct { ResourceIdentifier map[string]*string `type:"map" required:"true"` // The type of the resource, such as AWS::DynamoDB::Table. For the list of supported - // resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-supported-resources.html) - // In the CloudFormation User Guide + // resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) + // In the CloudFormation User Guide. // // ResourceType is a required field ResourceType *string `min:"1" type:"string" required:"true"` @@ -20847,8 +20851,9 @@ type SetStackPolicyInput struct { // Location of a file containing the stack policy. The URL must point to a policy // (maximum size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web - // Services Region as the stack. You can specify either the StackPolicyBody - // or the StackPolicyURL parameter, but not both. + // Services Region as the stack. The location for an Amazon S3 bucket must start + // with https://. You can specify either the StackPolicyBody or the StackPolicyURL + // parameter, but not both. StackPolicyURL *string `min:"1" type:"string"` } @@ -20957,11 +20962,11 @@ type SetTypeConfigurationInput struct { // The Amazon Resource Name (ARN) for the extension, in this account and Region. // - // For public extensions, this will be the ARN assigned when you activate the - // type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) - // in this account and Region. For private extensions, this will be the ARN - // assigned when you register the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) - // in this account and Region. + // For public extensions, this will be the ARN assigned when you call the ActivateType + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // API operation in this account and Region. For private extensions, this will + // be the ARN assigned when you call the RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // API operation in this account and Region. // // Do not include the extension versions suffix at the end of the ARN. You can // set the configuration for an extension, but not for a specific extension @@ -21327,6 +21332,14 @@ type Stack struct { // A user-defined description associated with the stack. Description *string `min:"1" type:"string"` + // The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is + // present, the resource or resource configuration phase has completed and the + // stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE + // when all of the resources in the stack have reached that event. For more + // information, see CloudFormation stack deployment (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html) + // in the CloudFormation User Guide. + DetailedStatus *string `type:"string" enum:"DetailedStatus"` + // Boolean to enable or disable rollback on stack creation failures: // // * true: disable rollback. @@ -21465,6 +21478,12 @@ func (s *Stack) SetDescription(v string) *Stack { return s } +// SetDetailedStatus sets the DetailedStatus field's value. +func (s *Stack) SetDetailedStatus(v string) *Stack { + s.DetailedStatus = &v + return s +} + // SetDisableRollback sets the DisableRollback field's value. func (s *Stack) SetDisableRollback(v bool) *Stack { s.DisableRollback = &v @@ -21711,6 +21730,19 @@ type StackEvent struct { // stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ClientRequestToken *string `min:"1" type:"string"` + // An optional field containing information about the detailed status of the + // stack event. + // + // * CONFIGURATION_COMPLETE - all of the resources in the stack have reached + // that event. For more information, see CloudFormation stack deployment + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html) + // in the CloudFormation User Guide. + // + // * VALIDATION_FAILED - template validation failed because of invalid properties + // in the template. The ResourceStatusReason field shows what properties + // are defined incorrectly. + DetailedStatus *string `type:"string" enum:"DetailedStatus"` + // The unique ID of this event. // // EventId is a required field @@ -21797,6 +21829,12 @@ func (s *StackEvent) SetClientRequestToken(v string) *StackEvent { return s } +// SetDetailedStatus sets the DetailedStatus field's value. +func (s *StackEvent) SetDetailedStatus(v string) *StackEvent { + s.DetailedStatus = &v + return s +} + // SetEventId sets the EventId field's value. func (s *StackEvent) SetEventId(v string) *StackEvent { s.EventId = &v @@ -21955,7 +21993,11 @@ type StackInstance struct { // stack in an unstable state. Stacks in this state are excluded from further // UpdateStackSet operations. You might need to perform a DeleteStackInstances // operation, with RetainStacks set to true, to delete the stack instance, - // and then delete the stack manually. + // and then delete the stack manually. INOPERABLE can be returned here when + // the cause is a failed import. If it's due to a failed import, the operation + // can be retried once the failures are fixed. To see if this is due to a + // failed import, look at the DetailedStatus member in the StackInstanceSummary + // member that is a peer to this Status member. // // * OUTDATED: The stack isn't currently up to date with the stack set because: // The associated stack failed during a CreateStackSet or UpdateStackSet @@ -22072,6 +22114,12 @@ type StackInstanceComprehensiveStatus struct { // the stack set operation fails in enough accounts within a Region, the // failure tolerance for the stack set operation as a whole might be exceeded. // + // * FAILED_IMPORT: The import of the stack instance in the specified account + // and Region failed and left the stack in an unstable state. Once the issues + // causing the failure are fixed, the import operation can be retried. If + // enough stack set operations fail in enough accounts within a Region, the + // failure tolerance for the stack set operation as a whole might be exceeded. + // // * INOPERABLE: A DeleteStackInstances operation has failed and left the // stack in an unstable state. Stacks in this state are excluded from further // UpdateStackSet operations. You might need to perform a DeleteStackInstances @@ -22354,7 +22402,11 @@ type StackInstanceSummary struct { // stack in an unstable state. Stacks in this state are excluded from further // UpdateStackSet operations. You might need to perform a DeleteStackInstances // operation, with RetainStacks set to true, to delete the stack instance, - // and then delete the stack manually. + // and then delete the stack manually. INOPERABLE can be returned here when + // the cause is a failed import. If it's due to a failed import, the operation + // can be retried once the failures are fixed. To see if this is due to a + // failed import, call the DescribeStackInstance API operation, look at the + // DetailedStatus member returned in the StackInstanceSummary member. // // * OUTDATED: The stack isn't currently up to date with the stack set because: // The associated stack failed during a CreateStackSet or UpdateStackSet @@ -25154,11 +25206,11 @@ type TypeConfigurationDetails struct { // The Amazon Resource Name (ARN) for the extension, in this account and Region. // - // For public extensions, this will be the ARN assigned when you activate the - // type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) - // in this account and Region. For private extensions, this will be the ARN - // assigned when you register the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) - // in this account and Region. + // For public extensions, this will be the ARN assigned when you call the ActivateType + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // API operation in this account and Region. For private extensions, this will + // be the ARN assigned when you call the RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // API operation in this account and Region. TypeArn *string `type:"string"` // The name of the extension. @@ -25234,11 +25286,11 @@ type TypeConfigurationIdentifier struct { // The Amazon Resource Name (ARN) for the extension, in this account and Region. // - // For public extensions, this will be the ARN assigned when you activate the - // type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) - // in this account and Region. For private extensions, this will be the ARN - // assigned when you register the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) - // in this account and Region. + // For public extensions, this will be the ARN assigned when you call the ActivateType + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // API operation in this account and Region. For private extensions, this will + // be the ARN assigned when you call the RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // API operation in this account and Region. TypeArn *string `type:"string"` // The alias specified for this configuration, if one was specified when the @@ -25488,9 +25540,9 @@ type TypeSummary struct { // The name of the extension. // - // If you specified a TypeNameAlias when you activate this extension (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) - // in your account and Region, CloudFormation considers that alias as the type - // name. + // If you specified a TypeNameAlias when you call the ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // API operation in your account and Region, CloudFormation considers that alias + // as the type name. TypeName *string `min:"10" type:"string"` } @@ -25995,8 +26047,9 @@ type UpdateStackInput struct { // Location of a file containing the temporary overriding stack policy. The // URL must point to a policy (max size: 16KB) located in an S3 bucket in the - // same Region as the stack. You can specify either the StackPolicyDuringUpdateBody - // or the StackPolicyDuringUpdateURL parameter, but not both. + // same Region as the stack. The location for an Amazon S3 bucket must start + // with https://. You can specify either the StackPolicyDuringUpdateBody or + // the StackPolicyDuringUpdateURL parameter, but not both. // // If you want to update protected resources, specify a temporary overriding // stack policy during this update. If you don't specify a stack policy, the @@ -26005,8 +26058,9 @@ type UpdateStackInput struct { // Location of a file containing the updated stack policy. The URL must point // to a policy (max size: 16KB) located in an S3 bucket in the same Region as - // the stack. You can specify either the StackPolicyBody or the StackPolicyURL - // parameter, but not both. + // the stack. The location for an Amazon S3 bucket must start with https://. + // You can specify either the StackPolicyBody or the StackPolicyURL parameter, + // but not both. // // You might update the stack policy, for example, in order to protect a new // resource that you created during a stack update. If you don't specify a stack @@ -26034,7 +26088,8 @@ type UpdateStackInput struct { // Location of file containing the template body. The URL must point to a template // that's located in an Amazon S3 bucket or a Systems Manager document. For // more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the CloudFormation User Guide. + // in the CloudFormation User Guide. The location for an Amazon S3 bucket must + // start with https://. // // Conditional: You must specify only one of the following parameters: TemplateBody, // TemplateURL, or set the UsePreviousTemplate to true. @@ -27047,7 +27102,8 @@ type ValidateTemplateInput struct { // Location of file containing the template body. The URL must point to a template // (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems // Manager document. For more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the CloudFormation User Guide. + // in the CloudFormation User Guide. The location for an Amazon S3 bucket must + // start with https://. // // Conditional: You must pass TemplateURL or TemplateBody. If both are passed, // only TemplateBody is used. @@ -27607,6 +27663,22 @@ func DeprecatedStatus_Values() []string { } } +const ( + // DetailedStatusConfigurationComplete is a DetailedStatus enum value + DetailedStatusConfigurationComplete = "CONFIGURATION_COMPLETE" + + // DetailedStatusValidationFailed is a DetailedStatus enum value + DetailedStatusValidationFailed = "VALIDATION_FAILED" +) + +// DetailedStatus_Values returns all elements of the DetailedStatus enum +func DetailedStatus_Values() []string { + return []string{ + DetailedStatusConfigurationComplete, + DetailedStatusValidationFailed, + } +} + const ( // DifferenceTypeAdd is a DifferenceType enum value DifferenceTypeAdd = "ADD" @@ -28420,6 +28492,9 @@ const ( // StackInstanceDetailedStatusSkippedSuspendedAccount is a StackInstanceDetailedStatus enum value StackInstanceDetailedStatusSkippedSuspendedAccount = "SKIPPED_SUSPENDED_ACCOUNT" + + // StackInstanceDetailedStatusFailedImport is a StackInstanceDetailedStatus enum value + StackInstanceDetailedStatusFailedImport = "FAILED_IMPORT" ) // StackInstanceDetailedStatus_Values returns all elements of the StackInstanceDetailedStatus enum @@ -28432,6 +28507,7 @@ func StackInstanceDetailedStatus_Values() []string { StackInstanceDetailedStatusCancelled, StackInstanceDetailedStatusInoperable, StackInstanceDetailedStatusSkippedSuspendedAccount, + StackInstanceDetailedStatusFailedImport, } } diff --git a/service/fsx/api.go b/service/fsx/api.go index 918a9dfe56..ac0622569c 100644 --- a/service/fsx/api.go +++ b/service/fsx/api.go @@ -3396,8 +3396,8 @@ func (c *FSx) DescribeSharedVpcConfigurationRequest(input *DescribeSharedVpcConf // // Indicates whether participant accounts in your organization can create Amazon // FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by -// a virtual private cloud (VPC) owner. For more information, see the Amazon -// FSx for NetApp ONTAP User Guide (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html). +// a virtual private cloud (VPC) owner. For more information, see Creating FSx +// for ONTAP file systems in shared subnets (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/creating-file-systems.html#fsxn-vpc-shared-subnets). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7279,8 +7279,8 @@ func (s *CopySnapshotAndUpdateVolumeOutput) SetVolumeId(v string) *CopySnapshotA return s } -// Used to specify the configuration options for a volume's storage aggregate -// or aggregates. +// Used to specify the configuration options for an FSx for ONTAP volume's storage +// aggregate or aggregates. type CreateAggregateConfiguration struct { _ struct{} `type:"structure"` @@ -8612,6 +8612,9 @@ type CreateFileSystemInput struct { // A list of IDs specifying the security groups to apply to all network interfaces // created for file system access. This list isn't returned in later requests // to describe the file system. + // + // You must specify a security group if you are creating a Multi-AZ FSx for + // ONTAP file system in a VPC subnet that has been shared with you. SecurityGroupIds []*string `type:"list"` // Sets the storage capacity of the file system that you're creating, in gibibytes @@ -8634,8 +8637,8 @@ type CreateFileSystemInput struct { // // FSx for ONTAP file systems - The amount of storage capacity that you can // configure depends on the value of the HAPairs property. The minimum value - // is calculated as 1,024 * HAPairs and the maxium is calculated as 524,288 - // * HAPairs.. + // is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 + // * HAPairs. // // FSx for OpenZFS file systems - The amount of storage capacity that you can // configure is from 64 GiB up to 524,288 GiB (512 TiB). @@ -9242,16 +9245,18 @@ type CreateFileSystemOntapConfiguration struct { // String and GoString methods. FsxAdminPassword *string `min:"8" type:"string" sensitive:"true"` - // Specifies how many high-availability (HA) pairs the file system will have. - // The default value is 1. The value of this property affects the values of - // StorageCapacity, Iops, and ThroughputCapacity. For more information, see - // High-availability (HA) pairs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html) + // Specifies how many high-availability (HA) pairs of file servers will power + // your file system. Scale-up file systems are powered by 1 HA pair. The default + // value is 1. FSx for ONTAP scale-out file systems are powered by up to 12 + // HA pairs. The value of this property affects the values of StorageCapacity, + // Iops, and ThroughputCapacity. For more information, see High-availability + // (HA) pairs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html) // in the FSx for ONTAP user guide. // // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following // conditions: // - // * The value of HAPairs is less than 1 or greater than 6. + // * The value of HAPairs is less than 1 or greater than 12. // // * The value of HAPairs is greater than 1 and the value of DeploymentType // is SINGLE_AZ_1 or MULTI_AZ_1. @@ -9266,6 +9271,12 @@ type CreateFileSystemOntapConfiguration struct { // all virtual private cloud (VPC) route tables associated with the subnets // in which your clients are located. By default, Amazon FSx selects your VPC's // default route table. + // + // Amazon FSx manages these route tables for Multi-AZ file systems using tag-based + // authentication. These route tables are tagged with Key: AmazonFSx; Value: + // ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using + // CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx + // tag manually. RouteTableIds []*string `type:"list"` // Sets the throughput capacity for the file system that you're creating in @@ -9286,16 +9297,16 @@ type CreateFileSystemOntapConfiguration struct { // Use to choose the throughput capacity per HA pair, rather than the total // throughput for the file system. // - // This field and ThroughputCapacity cannot be defined in the same API call, - // but one is required. + // You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity + // when creating a file system, but not both. // - // This field and ThroughputCapacity are the same for file systems with one - // HA pair. + // This field and ThroughputCapacity are the same for scale-up file systems + // powered by one HA pair. // - // * For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, - // 2048, or 4096 MBps. + // * For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, + // 512, 1024, 2048, or 4096 MBps. // - // * For SINGLE_AZ_2, valid values are 3072 or 6144 MBps. + // * For SINGLE_AZ_2 file systems, valid values are 3072 or 6144 MBps. // // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following // conditions: @@ -9305,7 +9316,7 @@ type CreateFileSystemOntapConfiguration struct { // // * The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / // ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and - // 6). + // 12). // // * The value of ThroughputCapacityPerHAPair is not a valid value. ThroughputCapacityPerHAPair *int64 `min:"128" type:"integer"` @@ -10006,7 +10017,7 @@ type CreateOntapVolumeConfiguration struct { // is not specified, it is automatically set to the root volume's security style. // The security style determines the type of permissions that FSx for ONTAP // uses to control data access. For more information, see Volume security style - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style) + // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style) // in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following // values: // @@ -10018,14 +10029,19 @@ type CreateOntapVolumeConfiguration struct { // of users are SMB clients, and an application accessing the data uses a // Windows user as the service account. // - // * MIXED if the file system is managed by both UNIX and Windows administrators - // and users consist of both NFS and SMB clients. + // * MIXED This is an advanced setting. For more information, see the topic + // What the security styles and their effects are (https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html) + // in the NetApp Documentation Center. + // + // For more information, see Volume security style (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html) + // in the FSx for ONTAP User Guide. SecurityStyle *string `type:"string" enum:"SecurityStyle"` - // The configured size of the volume, in bytes. + // Specifies the configured size of the volume, in bytes. SizeInBytes *int64 `type:"long"` - // Specifies the size of the volume, in megabytes (MB), that you are creating. + // Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), + // that you are creating. // // Deprecated: This property is deprecated, use SizeInBytes instead SizeInMegabytes *int64 `deprecated:"true" type:"integer"` @@ -10055,8 +10071,10 @@ type CreateOntapVolumeConfiguration struct { SnapshotPolicy *string `min:"1" type:"string"` // Set to true to enable deduplication, compression, and compaction storage - // efficiency features on the volume, or set to false to disable them. This - // parameter is required. + // efficiency features on the volume, or set to false to disable them. + // + // StorageEfficiencyEnabled is required when creating a RW volume (OntapVolumeType + // set to RW). StorageEfficiencyEnabled *bool `type:"boolean"` // Specifies the ONTAP SVM in which to create the volume. @@ -10084,9 +10102,10 @@ type CreateOntapVolumeConfiguration struct { // it from being moved to the capacity pool tier. TieringPolicy *TieringPolicy `type:"structure"` - // Use to specify the style of an ONTAP volume. For more information about FlexVols - // and FlexGroups, see Volume types (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types.html) - // in Amazon FSx for NetApp ONTAP User Guide. + // Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles + // of volumes that you can use for different purposes, FlexVol and FlexGroup + // volumes. For more information, see Volume styles (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-styles.html) + // in the Amazon FSx for NetApp ONTAP User Guide. VolumeStyle *string `type:"string" enum:"VolumeStyle"` } @@ -10385,7 +10404,7 @@ type CreateOpenZFSVolumeConfiguration struct { // in the Amazon FSx for OpenZFS User Guide. StorageCapacityReservationGiB *int64 `type:"integer"` - // An object specifying how much storage users or groups can use on the volume. + // Configures how much storage users and groups can use on the volume. UserAndGroupQuotas []*OpenZFSUserOrGroupQuota `type:"list"` } @@ -10790,7 +10809,7 @@ type CreateStorageVirtualMachineInput struct { // Describes the self-managed Microsoft Active Directory to which you want to // join the SVM. Joining an Active Directory provides user authentication and - // access control for SMB clients, including Microsoft Windows and macOS client + // access control for SMB clients, including Microsoft Windows and macOS clients // accessing the file system. ActiveDirectoryConfiguration *CreateSvmActiveDirectoryConfiguration `type:"structure"` @@ -10816,12 +10835,13 @@ type CreateStorageVirtualMachineInput struct { // of users are NFS clients, and an application accessing the data uses a // UNIX user as the service account. // - // * NTFS if the file system is managed by a Windows administrator, the majority - // of users are SMB clients, and an application accessing the data uses a - // Windows user as the service account. + // * NTFS if the file system is managed by a Microsoft Windows administrator, + // the majority of users are SMB clients, and an application accessing the + // data uses a Microsoft Windows user as the service account. // - // * MIXED if the file system is managed by both UNIX and Windows administrators - // and users consist of both NFS and SMB clients. + // * MIXED This is an advanced setting. For more information, see Volume + // security style (fsx/latest/ONTAPGuide/volume-security-style.html) in the + // Amazon FSx for NetApp ONTAP User Guide. RootVolumeSecurityStyle *string `type:"string" enum:"StorageVirtualMachineRootVolumeSecurityStyle"` // The password to use when managing the SVM using the NetApp ONTAP CLI or REST @@ -10977,7 +10997,7 @@ func (s *CreateStorageVirtualMachineOutput) SetStorageVirtualMachine(v *StorageV // The configuration that Amazon FSx uses to join the ONTAP storage virtual // machine (SVM) to your self-managed (including on-premises) Microsoft Active -// Directory (AD) directory. +// Directory directory. type CreateSvmActiveDirectoryConfiguration struct { _ struct{} `type:"structure"` @@ -14604,9 +14624,9 @@ type DescribeSnapshotsInput struct { // The filters structure. The supported names are file-system-id or volume-id. Filters []*SnapshotFilter `type:"list"` - // Set to false (default) if you want to only see the snapshots in your Amazon - // Web Services account. Set to true if you want to see the snapshots in your - // account and the ones shared with you from another account. + // Set to false (default) if you want to only see the snapshots owned by your + // Amazon Web Services account. Set to true if you want to see the snapshots + // in your account and the ones shared with you from another account. IncludeShared *bool `type:"boolean"` // The maximum number of resources to return in the response. This value must @@ -15105,8 +15125,7 @@ type DiskIopsConfiguration struct { Iops *int64 `type:"long"` // Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS - // of 3 IOPS per GB of storage capacity, , or if it using a USER_PROVISIONED - // value. + // of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value. Mode *string `type:"string" enum:"DiskIopsConfigurationMode"` } @@ -16149,8 +16168,8 @@ type FileSystem struct { SubnetIds []*string `type:"list"` // The tags to associate with the file system. For more information, see Tagging - // your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) - // in the Amazon EC2 User Guide. + // your Amazon FSx resources (https://docs.aws.amazon.com/fsx/latest/LustreGuide/tag-resources.html) + // in the Amazon FSx for Lustre User Guide. Tags []*Tag `min:"1" type:"list"` // The ID of the primary virtual private cloud (VPC) for the file system. @@ -18233,7 +18252,7 @@ type OntapFileSystemConfiguration struct { // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following // conditions: // - // * The value of HAPairs is less than 1 or greater than 6. + // * The value of HAPairs is less than 1 or greater than 12. // // * The value of HAPairs is greater than 1 and the value of DeploymentType // is SINGLE_AZ_1 or MULTI_AZ_1. @@ -18275,7 +18294,7 @@ type OntapFileSystemConfiguration struct { // // * The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / // ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and - // 6). + // 12). // // * The value of ThroughputCapacityPerHAPair is not a valid value. ThroughputCapacityPerHAPair *int64 `min:"128" type:"integer"` @@ -19123,21 +19142,24 @@ func (s *OpenZFSOriginSnapshotConfiguration) SetSnapshotARN(v string) *OpenZFSOr return s } -// The configuration for how much storage a user or group can use on the volume. +// Used to configure quotas that define how much storage a user or group can +// use on an FSx for OpenZFS volume. For more information, see Volume properties +// (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) +// in the FSx for OpenZFS User Guide. type OpenZFSUserOrGroupQuota struct { _ struct{} `type:"structure"` - // The ID of the user or group. + // The ID of the user or group that the quota applies to. // // Id is a required field Id *int64 `type:"integer" required:"true"` - // The amount of storage that the user or group can use in gibibytes (GiB). + // The user or group's storage quota, in gibibytes (GiB). // // StorageCapacityQuotaGiB is a required field StorageCapacityQuotaGiB *int64 `type:"integer" required:"true"` - // A value that specifies whether the quota applies to a user or group. + // Specifies whether the quota applies to a user or group. // // Type is a required field Type *string `type:"string" required:"true" enum:"OpenZFSQuotaType"` @@ -22567,7 +22589,7 @@ type UpdateFileSystemOntapConfiguration struct { // // * The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / // ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and - // 6). + // 12). // // * The value of ThroughputCapacityPerHAPair is not a valid value. ThroughputCapacityPerHAPair *int64 `min:"128" type:"integer"` diff --git a/service/organizations/api.go b/service/organizations/api.go index 33de9e1684..277c014017 100644 --- a/service/organizations/api.go +++ b/service/organizations/api.go @@ -24716,7 +24716,8 @@ type OrganizationalUnit struct { // in the Amazon Web Services Service Authorization Reference. Arn *string `type:"string"` - // The unique identifier (ID) associated with this OU. + // The unique identifier (ID) associated with this OU. The ID is unique to the + // organization only. // // The regex pattern (http://wikipedia.org/wiki/regex) for an organizational // unit ID string requires "ou-" followed by from 4 to 32 lowercase letters @@ -26161,7 +26162,8 @@ type Root struct { // in the Amazon Web Services Service Authorization Reference. Arn *string `type:"string"` - // The unique identifier (ID) for the root. + // The unique identifier (ID) for the root. The ID is unique to the organization + // only. // // The regex pattern (http://wikipedia.org/wiki/regex) for a root ID string // requires "r-" followed by from 4 to 32 lowercase letters or digits.