{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.cloudformation#AcceptTermsAndConditions": { "type": "boolean" }, "com.amazonaws.cloudformation#Account": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.cloudformation#AccountFilterType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "INTERSECTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERSECTION" } }, "DIFFERENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIFFERENCE" } }, "UNION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNION" } } } }, "com.amazonaws.cloudformation#AccountGateResult": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.cloudformation#AccountGateStatus", "traits": { "smithy.api#documentation": "
The status of the account gate function.
\n\n SUCCEEDED: The account gate function has determined that the account and\n Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the\n stack operation in that account and Region.
\n FAILED: The account gate function has determined that the account and Region\n doesn't meet the requirements for a StackSet operation to occur. CloudFormation cancels the\n StackSet operation in that account and Region, and sets the StackSet operation result status\n for that account and Region to FAILED.
\n SKIPPED: CloudFormation has skipped calling the account gate function for this\n account and Region, for one of the following reasons:
An account gate function hasn't been specified for the account and Region. CloudFormation\n proceeds with the StackSet operation in this account and Region.
\nThe AWSCloudFormationStackSetExecutionRole of the administration account\n lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in\n this account and Region.
Either no action is necessary, or no action is possible, on the stack. CloudFormation skips\n the StackSet operation in this account and Region.
\nThe reason for the account gate status assigned to this account and Region for the StackSet\n operation.
" } } }, "traits": { "smithy.api#documentation": "Structure that contains the results of the account gate function which CloudFormation invokes,\n if present, before proceeding with a StackSet operation in an account and Region.
\nFor each account and Region, CloudFormation lets you specify a Lambda function that encapsulates\n any requirements that must be met before CloudFormation can proceed with a StackSet operation in that\n account and Region. CloudFormation invokes the function each time a StackSet operation is requested\n for that account and Region; if the function returns FAILED, CloudFormation cancels the\n operation in that account and Region, and sets the StackSet operation result status for that\n account and Region to FAILED.
For more information, see Prevent failed StackSets\n deployments using target account gates in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#AccountGateStatus": { "type": "enum", "members": { "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "SKIPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIPPED" } } } }, "com.amazonaws.cloudformation#AccountGateStatusReason": { "type": "string" }, "com.amazonaws.cloudformation#AccountLimit": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudformation#LimitName", "traits": { "smithy.api#documentation": "The name of the account limit.
\nValues: ConcurrentResourcesLimit | StackLimit |\n StackOutputsLimit\n
The value that's associated with the account limit name.
" } } }, "traits": { "smithy.api#documentation": "Describes the current CloudFormation limits for your account.
\nCloudFormation has the following limits per account:
\nNumber of concurrent resources
\nNumber of stacks
\nNumber of stack outputs
\nFor more information, see Understand CloudFormation\n quotas in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#AccountLimitList": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#AccountLimit" } }, "com.amazonaws.cloudformation#AccountList": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#Account" } }, "com.amazonaws.cloudformation#AccountsUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5120 }, "smithy.api#pattern": "^(s3://|http(s?)://).+$" } }, "com.amazonaws.cloudformation#ActivateOrganizationsAccess": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput" }, "output": { "target": "com.amazonaws.cloudformation#ActivateOrganizationsAccessOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#InvalidOperationException" }, { "target": "com.amazonaws.cloudformation#OperationNotFoundException" } ], "traits": { "smithy.api#documentation": "Activate trusted access with Organizations. With trusted access between StackSets\n and Organizations activated, the management account has permissions to create\n and manage StackSets for your organization.
" } }, "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ActivateOrganizationsAccessOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#ActivateType": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ActivateTypeInput" }, "output": { "target": "com.amazonaws.cloudformation#ActivateTypeOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CFNRegistryException" }, { "target": "com.amazonaws.cloudformation#TypeNotFoundException" } ], "traits": { "smithy.api#documentation": "Activates a public third-party extension, such as a resource or module, to make it\n available for use in stack templates in your current account and Region. It can also create\n CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation\n provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations.
\nAfter you activate an extension, you can use SetTypeConfiguration to set specific properties for the extension.
\nTo see which extensions have been activated, use ListTypes. To see\n configuration details for an extension, use DescribeType.
\nFor more information, see Activate a\n third-party public extension in your account in the\n CloudFormation User Guide. For information about creating Hooks, see the\n CloudFormation Hooks User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudformation#ActivateTypeInput": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { "smithy.api#documentation": "The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
An alias to assign to the public extension in this account and Region. If you specify an\n alias for the extension, CloudFormation treats the alias as the extension type name within this\n account and Region. You must use the alias to refer to the extension in your templates, API\n calls, and CloudFormation console.
\nAn extension alias must be unique within a given account and Region. You can activate the\n same public resource multiple times in the same account and Region, using different type name\n aliases.
" } }, "AutoUpdate": { "target": "com.amazonaws.cloudformation#AutoUpdate", "traits": { "smithy.api#documentation": "Whether to automatically update the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions\n released by the publisher must be manually updated.
\nThe default is true.
Contains logging configuration information for an extension.
" } }, "ExecutionRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { "smithy.api#documentation": "The name of the IAM execution role to use to activate the extension.
" } }, "VersionBump": { "target": "com.amazonaws.cloudformation#VersionBump", "traits": { "smithy.api#documentation": "Manually updates a previously-activated type to a new major or minor version, if\n available. You can also use this parameter to update the value of\n AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if\n one is available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if\n one is available.
The major version of this extension you want to activate, if multiple major versions are\n available. The default is the latest major version. CloudFormation uses the latest available\n minor version of the major version selected.
\nYou can specify MajorVersion or VersionBump, but not\n both.
The Amazon Resource Name (ARN) of the activated extension in this account and\n Region.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#AfterContext": { "type": "string" }, "com.amazonaws.cloudformation#AfterValue": { "type": "string" }, "com.amazonaws.cloudformation#AfterValueFrom": { "type": "enum", "members": { "TEMPLATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEMPLATE" } } } }, "com.amazonaws.cloudformation#AliasName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.cloudformation#AllowedValue": { "type": "string" }, "com.amazonaws.cloudformation#AllowedValues": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#AllowedValue" } }, "com.amazonaws.cloudformation#AlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AlreadyExistsException", "httpResponseCode": 400 }, "smithy.api#documentation": "The resource with the name requested already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#Annotation": { "type": "structure", "members": { "AnnotationName": { "target": "com.amazonaws.cloudformation#AnnotationName", "traits": { "smithy.api#documentation": "An identifier for the evaluation logic that was used when invoking the Hook. For Control Tower,\n this is the control ID. For Guard, this is the rule ID. For Lambda and custom Hooks,\n this is a user-defined identifier.
" } }, "Status": { "target": "com.amazonaws.cloudformation#AnnotationStatus", "traits": { "smithy.api#documentation": "The status of the Hook invocation from the downstream service.
" } }, "StatusMessage": { "target": "com.amazonaws.cloudformation#RemediationMessageStatusMessage", "traits": { "smithy.api#documentation": "The explanation for the specific status assigned to this Hook invocation. For example,\n \"Bucket does not block public access\".
" } }, "RemediationMessage": { "target": "com.amazonaws.cloudformation#RemediationMessageRemediationMessage", "traits": { "smithy.api#documentation": "Suggests what to change if your Hook returns a FAILED status. For example,\n \"Block public access to the bucket\".
A URL that you can access for additional remediation guidance.
" } }, "SeverityLevel": { "target": "com.amazonaws.cloudformation#AnnotationSeverityLevel", "traits": { "smithy.api#documentation": "The relative risk associated with any violations of this type.
" } } }, "traits": { "smithy.api#documentation": "The Annotation data type.
A GetHookResult call returns detailed information and remediation guidance from\n Control Tower, Guard, Lambda, or custom Hooks for a Hook invocation result.
If set to true, StackSets automatically deploys additional stack instances to\n Organizations accounts that are added to a target organization or organizational unit\n (OU) in the specified Regions. If an account is removed from a target organization or OU,\n StackSets deletes stack instances from the account in the specified Regions.
If set to true, stack resources are retained when an account is removed from a\n target organization or OU. If set to false, stack resources are deleted. Specify\n only if Enabled is set to True.
A list of StackSet ARNs that this StackSet depends on for auto-deployment operations.\n When auto-deployment is triggered, operations will be sequenced to ensure all dependencies\n complete successfully before this StackSet's operation begins.
" } } }, "traits": { "smithy.api#documentation": "Describes whether StackSets automatically deploys to Organizations accounts that are\n added to a target organization or organizational unit (OU). For more information, see Enable or\n disable automatic deployments for StackSets in Organizations in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#AutoDeploymentNullable": { "type": "boolean" }, "com.amazonaws.cloudformation#AutoUpdate": { "type": "boolean" }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsInput" }, "output": { "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CFNRegistryException" }, { "target": "com.amazonaws.cloudformation#TypeConfigurationNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation\n registry in your current account and Region.
\nFor more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.cloudformation#ErrorCode", "traits": { "smithy.api#documentation": "The error code.
" } }, "ErrorMessage": { "target": "com.amazonaws.cloudformation#ErrorMessage", "traits": { "smithy.api#documentation": "The error message.
" } }, "TypeConfigurationIdentifier": { "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier", "traits": { "smithy.api#documentation": "Identifying information for the configuration of a CloudFormation extension.
" } } }, "traits": { "smithy.api#documentation": "Detailed information concerning an error generated during the setting of configuration data\n for a CloudFormation extension.
" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsInput": { "type": "structure", "members": { "TypeConfigurationIdentifiers": { "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifiers", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The list of identifiers for the desired extension configurations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsOutput": { "type": "structure", "members": { "Errors": { "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors", "traits": { "smithy.api#documentation": "A list of information concerning any errors generated during the setting of the specified\n configurations.
" } }, "UnprocessedTypeConfigurations": { "target": "com.amazonaws.cloudformation#UnprocessedTypeConfigurations", "traits": { "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process\n for any reason.
" } }, "TypeConfigurations": { "target": "com.amazonaws.cloudformation#TypeConfigurationDetailsList", "traits": { "smithy.api#documentation": "A list of any of the specified extension configurations from the CloudFormation\n registry.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#BeaconStackOperationStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.cloudformation#BeforeContext": { "type": "string" }, "com.amazonaws.cloudformation#BeforeValue": { "type": "string" }, "com.amazonaws.cloudformation#BeforeValueFrom": { "type": "enum", "members": { "PREVIOUS_DEPLOYMENT_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREVIOUS_DEPLOYMENT_STATE" } }, "ACTUAL_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTUAL_STATE" } } } }, "com.amazonaws.cloudformation#BoxedInteger": { "type": "integer" }, "com.amazonaws.cloudformation#BoxedMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.cloudformation#CFNRegistryException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage", "traits": { "smithy.api#documentation": "A message with details about the error that occurred.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "CFNRegistryException", "httpResponseCode": 400 }, "smithy.api#documentation": "An error occurred during a CloudFormation registry operation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#CallAs": { "type": "enum", "members": { "SELF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELF" } }, "DELEGATED_ADMIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELEGATED_ADMIN" } } } }, "com.amazonaws.cloudformation#CancelUpdateStack": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#CancelUpdateStackInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" } ], "traits": { "smithy.api#documentation": "Cancels an update on the specified stack. If the call completes successfully, the stack\n rolls back the update and reverts to the previous stack configuration.
\nYou can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
If you don't pass a parameter to StackName, the API returns a response that\n describes all resources in the account.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the\n request:
\n\n { \"Version\": \"2012-10-17\",\t\t \t \t \"Statement\": [{ \"Effect\": \"Deny\",\n \"Action\": \"cloudformation:DescribeStacks\", \"NotResource\":\n \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n
The name or the unique stack ID that's associated with the stack.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "A unique identifier for this CancelUpdateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an\n update on a stack with the same name. You might retry CancelUpdateStack requests\n to ensure that CloudFormation successfully received them.
The input for the CancelUpdateStack action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#CancelledStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#Capabilities": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#Capability" } }, "com.amazonaws.cloudformation#CapabilitiesReason": { "type": "string" }, "com.amazonaws.cloudformation#Capability": { "type": "enum", "members": { "CAPABILITY_IAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CAPABILITY_IAM" } }, "CAPABILITY_NAMED_IAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CAPABILITY_NAMED_IAM" } }, "CAPABILITY_AUTO_EXPAND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CAPABILITY_AUTO_EXPAND" } } } }, "com.amazonaws.cloudformation#Category": { "type": "enum", "members": { "REGISTERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REGISTERED" } }, "ACTIVATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVATED" } }, "THIRD_PARTY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "THIRD_PARTY" } }, "AWS_TYPES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_TYPES" } } } }, "com.amazonaws.cloudformation#CausingEntity": { "type": "string" }, "com.amazonaws.cloudformation#Change": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#ChangeType", "traits": { "smithy.api#documentation": "The type of entity that CloudFormation changes.
\n\n Resource This change is for a resource.
Is either null, if no Hooks invoke for the resource, or contains the number\n of Hooks that will invoke for the resource.
A ResourceChange structure that describes the resource and action that\n CloudFormation will perform.
The Change structure describes the changes CloudFormation will perform if you\n execute the change set.
The specific point in the provisioning process where the Hook is invoked.
" } }, "FailureMode": { "target": "com.amazonaws.cloudformation#HookFailureMode", "traits": { "smithy.api#documentation": "Specify the Hook failure mode for non-compliant resources in the followings ways.
\n\n FAIL Stops provisioning resources.
\n WARN Allows provisioning to continue with a warning message.
The unique name for your Hook. Specifies a three-part namespace for your Hook, with a\n recommended pattern of Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your Hook type\n names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n ASK\n
\n AWS\n
\n Custom\n
\n Dev\n
The version ID of the type specified.
" } }, "TypeConfigurationVersionId": { "target": "com.amazonaws.cloudformation#HookTypeConfigurationVersionId", "traits": { "smithy.api#documentation": "The version ID of the type configuration.
" } }, "TargetDetails": { "target": "com.amazonaws.cloudformation#ChangeSetHookTargetDetails", "traits": { "smithy.api#documentation": "Specifies details about the target that the Hook will run against.
" } } }, "traits": { "smithy.api#documentation": "Specifies the resource, the Hook, and the Hook version to be invoked.
" } }, "com.amazonaws.cloudformation#ChangeSetHookResourceTargetDetails": { "type": "structure", "members": { "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#documentation": "The resource's logical ID, which is defined in the stack's template.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#HookTargetTypeName", "traits": { "smithy.api#documentation": "The type of CloudFormation resource, such as AWS::S3::Bucket.
Specifies the action of the resource.
" } } }, "traits": { "smithy.api#documentation": "Specifies RESOURCE type target details for activated Hooks.
The Hook target type.
" } }, "ResourceTargetDetails": { "target": "com.amazonaws.cloudformation#ChangeSetHookResourceTargetDetails", "traits": { "smithy.api#documentation": "Required if TargetType is RESOURCE.
Specifies target details for an activated Hook.
" } }, "com.amazonaws.cloudformation#ChangeSetHooks": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ChangeSetHook" } }, "com.amazonaws.cloudformation#ChangeSetHooksStatus": { "type": "enum", "members": { "PLANNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PLANNING" } }, "PLANNED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PLANNED" } }, "UNAVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNAVAILABLE" } } } }, "com.amazonaws.cloudformation#ChangeSetId": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^arn:[-a-zA-Z0-9:/]*$" } }, "com.amazonaws.cloudformation#ChangeSetName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$" } }, "com.amazonaws.cloudformation#ChangeSetNameOrId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1600 }, "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*$" } }, "com.amazonaws.cloudformation#ChangeSetNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ChangeSetNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the\n ListChangeSets operation.
The ID of the stack with which the change set is associated.
" } }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#documentation": "The name of the stack with which the change set is associated.
" } }, "ChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { "smithy.api#documentation": "The ID of the change set.
" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { "smithy.api#documentation": "The name of the change set.
" } }, "ExecutionStatus": { "target": "com.amazonaws.cloudformation#ExecutionStatus", "traits": { "smithy.api#documentation": "If the change set execution status is AVAILABLE, you can execute the change\n set. If you can't execute the change set, the status indicates why. For example, a change set\n might be in an UNAVAILABLE state because CloudFormation is still creating it or in an\n OBSOLETE state because the stack was already updated.
The state of the change set, such as CREATE_PENDING,\n CREATE_COMPLETE, or FAILED.
A description of the change set's status. For example, if your change set is in the\n FAILED state, CloudFormation shows the error message.
The start time when the change set was created, in UTC.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "Descriptive information about the change set.
" } }, "IncludeNestedStacks": { "target": "com.amazonaws.cloudformation#IncludeNestedStacks", "traits": { "smithy.api#documentation": "Specifies the current setting of IncludeNestedStacks for the change set.
The parent change set ID.
" } }, "RootChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { "smithy.api#documentation": "The root change set ID.
" } }, "ImportExistingResources": { "target": "com.amazonaws.cloudformation#ImportExistingResources", "traits": { "smithy.api#documentation": "Indicates if the change set imports resources that already exist.
" } } }, "traits": { "smithy.api#documentation": "The ChangeSetSummary structure describes a change set, its status, and the\n stack with which it's associated.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and\n repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store,\n Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective\n applications without creating or configuring the underlying Amazon Web Services infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The\n template defines a collection of resources as a single unit called a stack. CloudFormation creates\n and deletes all member resources of the stack together and manages all dependencies between\n the resources for you.
\nFor more information about CloudFormation, see the CloudFormation product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information\n about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", "smithy.api#title": "AWS CloudFormation", "smithy.api#xmlNamespace": { "uri": "http://cloudformation.amazonaws.com/doc/2010-05-15/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudformation-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cloudformation.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudformation-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cloudformation.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cloudformation.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://cloudformation-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://cloudformation.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudformation-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://cloudformation.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://cloudformation.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudformation.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudformation.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudformation.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudformation-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.cloudformation#CompletedAccountsCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#CompletedStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#ConcurrencyMode": { "type": "enum", "members": { "STRICT_FAILURE_TOLERANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRICT_FAILURE_TOLERANCE" } }, "SOFT_FAILURE_TOLERANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOFT_FAILURE_TOLERANCE" } } } }, "com.amazonaws.cloudformation#ConcurrentResourcesLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ConcurrentResourcesLimitExceeded", "httpResponseCode": 429 }, "smithy.api#documentation": "No more than 5 generated templates can be in an InProgress or Pending status at one\n time. This error is also returned if a generated template that is in an InProgress or\n Pending status is attempted to be updated or deleted.
Continues rolling back a stack from UPDATE_ROLLBACK_FAILED to\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can\n manually fix the error and continue the rollback. By continuing the rollback, you can return\n your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state) and then try\n to update the stack again.
A stack enters the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll\n back all changes after a failed stack update. For example, this might occur when a stack\n attempts to roll back to an old database that was deleted outside of CloudFormation. Because\n CloudFormation doesn't know the instance was deleted, it assumes the instance still exists and\n attempts to roll back to it, causing the update rollback to fail.
For more information, see Continue rolling back an update in the CloudFormation User Guide. For\n information for troubleshooting a failed update rollback, see Update rollback failed.
\n\n ForceRollback and ResourcesToSkip are mutually exclusive.\n For details, see the ForceRollback parameter.
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the\n parent stack (the stack that contains the AWS::CloudFormation::Stack\n resource).
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to roll back the\n stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that's generated from\n your user credentials.
" } }, "ResourcesToSkip": { "target": "com.amazonaws.cloudformation#ResourcesToSkip", "traits": { "smithy.api#documentation": "A list of the logical IDs of the resources that CloudFormation skips during the continue\n update rollback operation. You can specify only resources that are in the\n UPDATE_FAILED state because a rollback failed. You can't specify resources that\n are in the UPDATE_FAILED state for other reasons, for example, because an update\n was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully\n roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the\n specified resources to UPDATE_COMPLETE and continues to roll back the stack.\n After the rollback is complete, the state of the skipped resources will be inconsistent with\n the state of the resources in the stack template. Before performing another stack update,\n you must update the stack or resources to be consistent with each other. If you don't,\n subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For\n example, a failed resource update might cause dependent resources to fail. In this case, it\n might not be necessary to skip the dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a\n stack resource (Type: AWS::CloudFormation::Stack) in the\n ResourcesToSkip list, then its corresponding embedded stack must be in one of\n the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or\n DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the\n parent stack. For an example of a continue update rollback operation with nested stacks, see\n Continue rolling back from failed nested stack updates.
\nA unique identifier for this ContinueUpdateRollback request. Specify this\n token if you plan to retry requests so that CloudFormation knows that you're not attempting to\n continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that CloudFormation successfully received\n them.
Specifies whether CloudFormation forces the rollback to continue by skipping resources\n currently in the UPDATE_FAILED state. Use this instead of listing each resource\n individually in ResourcesToSkip. Only resources that entered the\n UPDATE_FAILED state because a rollback failed are skipped. If you don't specify\n a value, the default is false and CloudFormation doesn't skip any resources.
\n ForceRollback and ResourcesToSkip are mutually exclusive.\n Specifying both in the same request returns a validation error.
We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the\n skipped resources to UPDATE_COMPLETE and continues to roll back the stack,\n including resources in nested stacks. After the rollback completes, the skipped resources no\n longer match the resources in the stack template. Before performing another stack update,\n you must update the stack or resources to be consistent with each other. If you don't,\n subsequent stack updates might fail, and the stack will become unrecoverable.
Drift detection reports skipped resources as NOT_CHECKED. For guidance,\n see Continue rolling back an update in the CloudFormation User Guide.
The input for the ContinueUpdateRollback action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ContinueUpdateRollbackOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The output for a ContinueUpdateRollback operation.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#CreateChangeSet": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#CreateChangeSetInput" }, "output": { "target": "com.amazonaws.cloudformation#CreateChangeSetOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#AlreadyExistsException" }, { "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" }, { "target": "com.amazonaws.cloudformation#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Creates a list of changes that will be applied to a stack so that you can review the\n changes before executing them. You can create a change set for a stack that doesn't exist or\n an existing stack. If you create a change set for a stack that doesn't exist, the change set\n shows all of the resources that CloudFormation will create. If you create a change set for an\n existing stack, CloudFormation compares the stack's information with the information that you\n submit in the change set and lists the differences. Use change sets to understand which\n resources CloudFormation will create or change, and how it will change resources in an existing\n stack, before you create or update a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType\n parameter, specify CREATE. To create a change set for an existing stack, specify\n UPDATE for the ChangeSetType parameter. To create a change set for\n an import operation, specify IMPORT for the ChangeSetType parameter.\n After the CreateChangeSet call successfully completes, CloudFormation starts creating\n the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set\n by using the ExecuteChangeSet action. CloudFormation doesn't make changes until\n you execute the change set.
\nTo create a change set for the entire stack hierarchy, set\n IncludeNestedStacks to True.
The name or the unique ID of the stack for which you are creating a change set. CloudFormation\n generates the change set by comparing this stack's information with the information that you\n submit, such as a modified template or different parameter input values.
", "smithy.api#required": {} } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "A structure that contains the body of the revised template, with a minimum length of 1\n byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing\n this template with the template of the stack that you specified.
\nConditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
The URL of the file that contains the revised template. The URL must point to a template\n (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation\n generates the change set by comparing this template with the stack that you specified. The\n location for an Amazon S3 bucket must start with https://. URLs from S3 static\n websites are not supported.
Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Whether to reuse the template that's associated with the stack to create the change\n set.
\nWhen using templates with the AWS::LanguageExtensions transform, provide the\n template instead of using UsePreviousTemplate to ensure new parameter values and\n Systems Manager parameter updates are applied correctly. For more information, see AWS::LanguageExtensions transform.
Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
A list of Parameter structures that specify input parameters for the change\n set. For more information, see the Parameter data type.
In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include\n and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when creating\n change sets has no effect.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack directly\n from the template using the CreateStack or UpdateStack action, and specifying this capability.
\nFor more information about macros, see Perform custom processing\n on CloudFormation templates with template macros.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
Specifies which resource types you can work with, such as AWS::EC2::Instance\n or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the\n stack update fails. By default, CloudFormation grants permissions to all resource types. IAM\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Control CloudFormation\n access with Identity and Access Management in the CloudFormation User Guide.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes when executing the\n change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that is generated from\n your user credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon SNS topics that CloudFormation associates with the\n stack. To remove all associated notification topics, specify an empty list.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to\n resources in the stack. You can specify a maximum of 50 tags.
" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the change set. The name must be unique among all change sets that are\n associated with the specified stack.
\nA change set name can contain only alphanumeric, case sensitive characters, and hyphens.\n It must start with an alphabetical character and can't exceed 128 characters.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.cloudformation#ClientToken", "traits": { "smithy.api#documentation": "A unique identifier for this CreateChangeSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to create\n another change set with the same name. You might retry CreateChangeSet requests\n to ensure that CloudFormation successfully received them.
A description to help you identify this change set.
" } }, "ChangeSetType": { "target": "com.amazonaws.cloudformation#ChangeSetType", "traits": { "smithy.api#documentation": "The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack\n ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS\n state until you execute the change set.
By default, CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the CREATE\n type to create a change set for an existing stack.
The resources to import into your stack.
" } }, "IncludeNestedStacks": { "target": "com.amazonaws.cloudformation#IncludeNestedStacks", "traits": { "smithy.api#documentation": "Creates a change set for the all nested stacks specified in the template. The default\n behavior of this action is set to False. To include nested sets in a change set,\n specify True.
Determines what action will be taken if stack creation fails. If this parameter is\n specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these\n values:
\n DELETE - Deletes the change set if the stack creation fails. This is only\n valid when the ChangeSetType parameter is set to CREATE. If the\n deletion of the stack fails, the status of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent\n to specifying true for the DisableRollback parameter to the\n ExecuteChangeSet API operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is\n equivalent to specifying false for the DisableRollback parameter\n to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to\n DELETE for the change set for the parent stack, any failure in a child stack\n will cause the parent stack creation to fail and all stacks to be deleted.
Indicates if the change set auto-imports resources that already exist. For more\n information, see Import Amazon Web Services\n resources into a CloudFormation stack automatically in the\n CloudFormation User Guide.
\nThis parameter can only import resources that have custom names in templates. For more\n information, see name\n type in the CloudFormation User Guide. To import resources that do not\n accept custom names, such as EC2 instances, use the ResourcesToImport parameter\n instead.
Determines how CloudFormation handles configuration drift during deployment.
\n\n REVERT_DRIFT \u2013 Creates a drift-aware change set that brings actual\n resource states in line with template definitions. Provides a three-way comparison between\n actual state, previous deployment state, and desired state.
For more information, see Using drift-aware\n change sets in the CloudFormation User Guide.
" } }, "DeploymentConfig": { "target": "com.amazonaws.cloudformation#DeploymentConfig", "traits": { "smithy.api#documentation": "The deployment configuration for this stack operation, including the deployment\n mode.
" } }, "DisableValidation": { "target": "com.amazonaws.cloudformation#DisableValidation", "traits": { "smithy.api#documentation": "\n Set to true to disable pre-deployment validations in changeset or stack operations.\n
\n Default: false\n
The input for the CreateChangeSet action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#CreateChangeSetOutput": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the change set.
" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "The unique ID of the stack.
" } } }, "traits": { "smithy.api#documentation": "The output for the CreateChangeSet action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#CreateGeneratedTemplate": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#CreateGeneratedTemplateInput" }, "output": { "target": "com.amazonaws.cloudformation#CreateGeneratedTemplateOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#AlreadyExistsException" }, { "target": "com.amazonaws.cloudformation#ConcurrentResourcesLimitExceededException" }, { "target": "com.amazonaws.cloudformation#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Creates a template from existing resources that are not already managed with CloudFormation.\n You can check the status of the template generation using the\n DescribeGeneratedTemplate API action.
An optional list of resources to be included in the generated template.
\nIf no resources are specified,the template will be created without any resources.\n Resources can be added to the template using the UpdateGeneratedTemplate API\n action.
The name assigned to the generated template.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#documentation": "An optional name or ARN of a stack to use as the base stack for the generated\n template.
" } }, "TemplateConfiguration": { "target": "com.amazonaws.cloudformation#TemplateConfiguration", "traits": { "smithy.api#documentation": "The configuration details of the generated template, including the\n DeletionPolicy and UpdateReplacePolicy.
The ID of the generated template.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#CreateStack": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#CreateStackInput" }, "output": { "target": "com.amazonaws.cloudformation#CreateStackOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#AlreadyExistsException" }, { "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" }, { "target": "com.amazonaws.cloudformation#LimitExceededException" }, { "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" } ], "traits": { "smithy.api#documentation": "Creates a stack as specified in the template. After the call completes successfully, the\n stack creation starts. You can check the status of the stack through the DescribeStacks operation.
\nFor more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services\n resources as a single unit with CloudFormation stacks in the\n CloudFormation User Guide.
", "smithy.test#smokeTests": [ { "id": "CreateStackFailure", "params": { "StackName": "fakestack", "TemplateURL": "http://s3.amazonaws.com/foo/bar" }, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "failure": {} } } ] } }, "com.amazonaws.cloudformation#CreateStackInput": { "type": "structure", "members": { "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name that's associated with the stack. The name must be unique in the Region in which\n you are creating the stack.
\nA stack name can contain only alphanumeric characters (case sensitive) and hyphens. It\n must start with an alphabetical character and can't be longer than 128 characters.
\nStructure that contains the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must specify either TemplateBody or\n TemplateURL, but not both.
The URL of a file that contains the template body. The URL must point to a template (max\n size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for\n an Amazon S3 bucket must start with https://. URLs from S3 static websites are not\n supported.
Conditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.
A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.
Set to true to disable rollback of the stack if stack creation failed. You\n can specify either DisableRollback or OnFailure, but not\n both.
Default: false\n
The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "TimeoutInMinutes": { "target": "com.amazonaws.cloudformation#TimeoutMinutes", "traits": { "smithy.api#documentation": "The amount of time that can pass before the stack status becomes\n CREATE_FAILED; if DisableRollback is not set or is set to\n false, the stack will be rolled back.
The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs\n using the Amazon SNS console or your Command Line Interface (CLI).
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n AWS::IAM::AccessKey\n
\n\n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n AWS::IAM::Role\n
\n\n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include\n and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create the stack directly from the\n template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if\n you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.
\nFor more information, see Perform custom processing\n on CloudFormation templates with template macros.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
Specifies which resource types you can work with, such as AWS::EC2::Instance\n or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're creating, the stack\n creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses\n this parameter for CloudFormation-specific condition keys in IAM policies. For more information,\n see Control CloudFormation\n access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the\n stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that's generated from\n your user credentials.
" } }, "OnFailure": { "target": "com.amazonaws.cloudformation#OnFailure", "traits": { "smithy.api#documentation": "Determines what action will be taken if stack creation fails. This must be one of:\n DO_NOTHING, ROLLBACK, or DELETE. You can specify\n either OnFailure or DisableRollback, but not both.
Although the default setting is ROLLBACK, there is one exception. This\n exception occurs when a StackSet attempts to deploy a stack instance and the stack instance\n fails to create successfully. In this case, the CreateStack call overrides the\n default setting and sets the value of OnFailure to DELETE.
Default: ROLLBACK\n
Structure that contains the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Location of a file that contains the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3\n bucket must start with https://. URLs from S3 static websites are not\n supported.
You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the\n resources created in the stack. A maximum number of 50 tags can be specified.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "A unique identifier for this CreateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to create a stack\n with the same name. You might retry CreateStack requests to ensure that\n CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Whether to enable termination protection on the specified stack. If a user attempts to\n delete a stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protect CloudFormation\n stacks from being deleted in the CloudFormation User Guide. Termination\n protection is deactivated on stacks by default.
\nFor nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" } }, "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { "smithy.api#documentation": "When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
The deployment configuration for this stack operation, including the deployment\n mode.
" } }, "DisableValidation": { "target": "com.amazonaws.cloudformation#DisableValidation", "traits": { "smithy.api#documentation": "\n Set to true to disable pre-deployment validations in changeset or stack operations.\n
\n Default: false\n
The input for CreateStack action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#CreateStackInstances": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#CreateStackInstancesInput" }, "output": { "target": "com.amazonaws.cloudformation#CreateStackInstancesOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#InvalidOperationException" }, { "target": "com.amazonaws.cloudformation#LimitExceededException" }, { "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" }, { "target": "com.amazonaws.cloudformation#OperationInProgressException" }, { "target": "com.amazonaws.cloudformation#StackSetNotFoundException" }, { "target": "com.amazonaws.cloudformation#StaleRequestException" } ], "traits": { "smithy.api#documentation": "Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A\n stack instance refers to a stack in a specific account and Region. You must specify at least\n one value for either Accounts or DeploymentTargets, and you must\n specify at least one value for Regions.
The maximum number of organizational unit (OUs) supported by a\n CreateStackInstances operation is 50.
If you need more than 50, consider the following options:
\n\n Batch processing: If you don't want to expose your OU\n hierarchy, split up the operations into multiple calls with less than 50 OUs\n each.
\n\n Parent OU strategy: If you don't mind exposing the OU\n hierarchy, target a parent OU that contains all desired child OUs.
\nThe name or unique ID of the StackSet that you want to create stack instances from.
", "smithy.api#required": {} } }, "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { "smithy.api#documentation": "[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts that you want to\n create stack instances in the specified Region(s) for.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
[Service-managed permissions] The Organizations accounts in which to create stack\n instances in the specified Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
The names of one or more Amazon Web Services Regions where you want to create stack instances using the\n specified Amazon Web Services accounts.
", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { "smithy.api#documentation": "A list of StackSet parameters whose values you want to override in the selected stack\n instances.
\nAny overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify its\n value.
\nTo leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the StackSet, specify a\n parameter list but don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at\n all.
\nDuring StackSet updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.
\nYou can only override the parameter values that are specified in the\n StackSet; to add or delete a parameter itself, use UpdateStackSet\n to update the StackSet template.
" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { "smithy.api#documentation": "Preferences for how CloudFormation performs this StackSet operation.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique identifier for this StackSet operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the StackSet operation only once, even if you retry the request multiple times. You\n might retry StackSet operation requests to ensure that CloudFormation successfully received\n them.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
\nRepeating this StackSet operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nThe unique identifier for this StackSet operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#CreateStackOutput": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "Unique identifier of the stack.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#OperationId", "traits": { "smithy.api#documentation": "A unique identifier for this stack operation that can be used to track the operation's\n progress and events.
" } } }, "traits": { "smithy.api#documentation": "The output for a CreateStack action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#CreateStackRefactor": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#CreateStackRefactorInput" }, "output": { "target": "com.amazonaws.cloudformation#CreateStackRefactorOutput" }, "traits": { "smithy.api#documentation": "Creates a refactor across multiple stacks, with the list of stacks and resources that are\n affected.
" } }, "com.amazonaws.cloudformation#CreateStackRefactorInput": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "A description to help you identify the stack refactor.
" } }, "EnableStackCreation": { "target": "com.amazonaws.cloudformation#EnableStackCreation", "traits": { "smithy.api#documentation": "Determines if a new stack is created with the refactor.
" } }, "ResourceMappings": { "target": "com.amazonaws.cloudformation#ResourceMappings", "traits": { "smithy.api#documentation": "The mappings for the stack resource Source and stack resource\n Destination.
The stacks being refactored.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#CreateStackRefactorOutput": { "type": "structure", "members": { "StackRefactorId": { "target": "com.amazonaws.cloudformation#StackRefactorId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID associated with the stack refactor created from the CreateStackRefactor action.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#CreateStackSet": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#CreateStackSetInput" }, "output": { "target": "com.amazonaws.cloudformation#CreateStackSetOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CreatedButModifiedException" }, { "target": "com.amazonaws.cloudformation#LimitExceededException" }, { "target": "com.amazonaws.cloudformation#NameAlreadyExistsException" } ], "traits": { "smithy.api#documentation": "Creates a StackSet.
" } }, "com.amazonaws.cloudformation#CreateStackSetInput": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name to associate with the StackSet. The name must be unique in the Region where you\n create your StackSet.
\nA stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It\n must start with an alphabetic character and can't be longer than 128 characters.
\nA description of the StackSet. You can use the description to identify the StackSet's\n purpose or other important information.
" } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes.
\nConditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.
The URL of a file that contains the template body. The URL must point to a template\n (maximum size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The\n location for an Amazon S3 bucket must start with https://. S3 static website URLs are\n not supported.
Conditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.
The stack ID you are importing into a new StackSet. Specify the Amazon Resource Name (ARN)\n of the stack.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { "smithy.api#documentation": "The input parameters for the StackSet template.
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your StackSet template contains\n certain capabilities in order for CloudFormation to create the StackSet and related stack\n instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those StackSets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n AWS::IAM::AccessKey\n
\n\n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n AWS::IAM::Role\n
\n\n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your StackSet template references one or more\n macros, you must create the StackSet directly from the processed template, without first\n reviewing the resulting changes in a change set. To create the StackSet directly, you must\n acknowledge this capability. For more information, see Perform custom processing\n on CloudFormation templates with template macros.
\nWith service-managed permissions, CloudFormation can process macros, nested stacks, and\n transforms in your StackSet template only when you provide a custom execution role\n template. (Macros include the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) The\n default service-managed execution role can't provision them: if you reference a macro\n in your template, the StackSet operation fails even when you specify this\n capability.
\nTo use macros, nested stacks, or transforms with service-managed permissions,\n specify a custom execution role template in\n ExecutionRoleTemplateBody or ExecutionRoleTemplateUrl, and\n specify both CAPABILITY_NAMED_IAM and\n CAPABILITY_AUTO_EXPAND.
The key-value pairs to associate with this StackSet and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks. A\n maximum number of 50 tags can be specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to\n see if you have the required IAM permission to tag resources. If you don't, the entire\n CreateStackSet action fails with an access denied error, and the\n StackSet is not created.
The Amazon Resource Name (ARN) of the IAM role to use to create this StackSet.
\nSpecify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific StackSets within the same administrator account. For\n more information, see Grant\n self-managed permissions in the CloudFormation User Guide.
\nValid only if the permissions model is SELF_MANAGED.
The name of the IAM execution role that CloudFormation uses for StackSet operations in your\n target accounts.
\n[Self-managed permissions] If you do not specify an execution role, CloudFormation uses the\n AWSCloudFormationStackSetExecutionRole role for the StackSet operation. Specify\n an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their StackSets.
[Service-managed permissions] Set this name when you use custom execution roles. The role\n that your custom execution role template provisions in your target accounts must have this\n same name, and the name must begin with\n stacksets-exec-custom-.
Describes how the IAM roles required for StackSet operations are created. By default,\n SELF-MANAGED is specified.
With self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n self-managed permissions.
With service-managed permissions, StackSets automatically creates the\n IAM roles required to deploy to accounts managed by Organizations. For more\n information, see Activate trusted access for StackSets with Organizations.
Describes whether StackSets automatically deploys to Organizations accounts that\n are added to the target organization or organizational unit (OU). For more information, see\n Enable or disable automatic deployments for StackSets in Organizations\n in the CloudFormation User Guide.
\nRequired if the permissions model is SERVICE_MANAGED. (Not used with\n self-managed permissions.)
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
To create a StackSet with service-managed permissions while signed in to the management account, specify SELF.
To create a StackSet with service-managed permissions while signed in to a delegated\n administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nStackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.
\nValid only if the permissions model is SERVICE_MANAGED.
A unique identifier for this CreateStackSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to create\n another StackSet with the same name. You might retry CreateStackSet requests to\n ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one\n automatically.
", "smithy.api#idempotencyToken": {} } }, "ManagedExecution": { "target": "com.amazonaws.cloudformation#ManagedExecution", "traits": { "smithy.api#documentation": "Describes whether CloudFormation performs non-conflicting operations concurrently and queues\n conflicting operations.
" } }, "ExecutionRoleTemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "The body of the template that creates a custom execution role in target accounts. This parameter applies only when the permissions model is SERVICE_MANAGED.
Conditional: Specify either ExecutionRoleTemplateBody or\n ExecutionRoleTemplateUrl, but not both. If you don't specify either, CloudFormation\n uses the default service-managed execution role in target accounts.
The URL of an Amazon S3 object that contains the template that creates a custom execution role in target accounts. This parameter applies only when the permissions model is SERVICE_MANAGED.
Conditional: Specify either ExecutionRoleTemplateBody or\n ExecutionRoleTemplateUrl, but not both. If you don't specify either, CloudFormation\n uses the default service-managed execution role in target accounts.
The name of the Amazon S3 bucket that stores the execution role stack template body. CloudFormation uses this bucket only when you specify a custom execution role template.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#CreateStackSetOutput": { "type": "structure", "members": { "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { "smithy.api#documentation": "The ID of the StackSet that you're creating.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#CreatedButModifiedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CreatedButModifiedException", "httpResponseCode": 409 }, "smithy.api#documentation": "The specified resource exists, but has been changed.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudformation#CreationTime": { "type": "timestamp" }, "com.amazonaws.cloudformation#DeactivateOrganizationsAccess": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput" }, "output": { "target": "com.amazonaws.cloudformation#DeactivateOrganizationsAccessOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#InvalidOperationException" }, { "target": "com.amazonaws.cloudformation#OperationNotFoundException" } ], "traits": { "smithy.api#documentation": "Deactivates trusted access with Organizations. If trusted access is deactivated,\n the management account does not have permissions to create and manage\n service-managed StackSets for your organization.
" } }, "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DeactivateOrganizationsAccessOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DeactivateType": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DeactivateTypeInput" }, "output": { "target": "com.amazonaws.cloudformation#DeactivateTypeOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CFNRegistryException" }, { "target": "com.amazonaws.cloudformation#TypeNotFoundException" } ], "traits": { "smithy.api#documentation": "Deactivates a public third-party extension, such as a resource or module, or a CloudFormation\n Hook when you no longer use it.
\nDeactivating an extension deletes the configuration details that are associated with it.\n To temporarily disable a CloudFormation Hook instead, you can use SetTypeConfiguration.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes\n stack update operations where the stack template includes the extension, even if no updates\n are being made to the extension. In addition, deactivated extensions aren't automatically\n updated if a new version of the extension is released.
\nTo see which extensions are currently activated, use ListTypes.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudformation#DeactivateTypeInput": { "type": "structure", "members": { "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "The type name of the extension in this account and Region. If you specified a type name\n alias when enabling the extension, use the type name alias.
\nConditional: You must specify either Arn, or TypeName and\n Type.
The extension type.
\nConditional: You must specify either Arn, or TypeName and\n Type.
The Amazon Resource Name (ARN) for the extension in this account and Region.
\nConditional: You must specify either Arn, or TypeName and\n Type.
Deletes the specified change set. Deleting change sets ensures that no one executes the\n wrong change set.
\nIf the call successfully completes, CloudFormation successfully deleted the change set.
\nIf IncludeNestedStacks specifies True during the creation of the\n nested change set, then DeleteChangeSet will delete all change sets that belong\n to the stacks hierarchy and will also delete all change sets for nested stacks with the status\n of REVIEW_IN_PROGRESS.
The name or Amazon Resource Name (ARN) of the change set that you want to delete.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#documentation": "If you specified the name of a change set to delete, specify the stack name or Amazon\n Resource Name (ARN) that's associated with it.
" } } }, "traits": { "smithy.api#documentation": "The input for the DeleteChangeSet action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DeleteChangeSetOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The output for the DeleteChangeSet action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DeleteGeneratedTemplate": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DeleteGeneratedTemplateInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cloudformation#ConcurrentResourcesLimitExceededException" }, { "target": "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException" } ], "traits": { "smithy.api#documentation": "Deleted a generated template.
", "smithy.api#examples": [ { "title": "To delete a generated template", "documentation": "This example deletes a generated template", "input": { "GeneratedTemplateName": "JazzyTemplate" } } ] } }, "com.amazonaws.cloudformation#DeleteGeneratedTemplateInput": { "type": "structure", "members": { "GeneratedTemplateName": { "target": "com.amazonaws.cloudformation#GeneratedTemplateName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of a generated template.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DeleteStack": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DeleteStackInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" } ], "traits": { "smithy.api#documentation": "Deletes a specified stack. Once the call completes successfully, stack deletion starts.\n Deleted stacks don't show up in the DescribeStacks operation if the deletion\n has been completed successfully.
\nFor more information about deleting a stack, see Delete a stack from\n the CloudFormation console in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#DeleteStackInput": { "type": "structure", "members": { "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack.
", "smithy.api#required": {} } }, "RetainResources": { "target": "com.amazonaws.cloudformation#RetainResources", "traits": { "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that\n are associated with the resources you want to retain. During deletion, CloudFormation deletes the\n stack but doesn't delete the retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3\n bucket, but you want to delete the stack.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the\n stack. CloudFormation uses the role's credentials to make calls on your behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that's generated from\n your user credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "A unique identifier for this DeleteStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack\n with the same name. You might retry DeleteStack requests to ensure that\n CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Specifies the deletion mode for the stack. Possible values are:
\n\n STANDARD - Use the standard behavior. Specifying this value is the same\n as not specifying this parameter.
\n FORCE_DELETE_STACK - Delete the stack if it's stuck in a\n DELETE_FAILED state due to resource deletion failure.
The deployment configuration for this stack operation, including the deployment\n mode.
" } } }, "traits": { "smithy.api#documentation": "The input for DeleteStack action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DeleteStackInstances": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DeleteStackInstancesInput" }, "output": { "target": "com.amazonaws.cloudformation#DeleteStackInstancesOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#InvalidOperationException" }, { "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" }, { "target": "com.amazonaws.cloudformation#OperationInProgressException" }, { "target": "com.amazonaws.cloudformation#StackSetNotFoundException" }, { "target": "com.amazonaws.cloudformation#StaleRequestException" } ], "traits": { "smithy.api#documentation": "Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
\nThe maximum number of organizational unit (OUs) supported by a\n DeleteStackInstances operation is 50.
If you need more than 50, consider the following options:
\n\n Batch processing: If you don't want to expose your OU\n hierarchy, split up the operations into multiple calls with less than 50 OUs\n each.
\n\n Parent OU strategy: If you don't mind exposing the OU\n hierarchy, target a parent OU that contains all desired child OUs.
\nThe name or unique ID of the StackSet that you want to delete stack instances for.
", "smithy.api#required": {} } }, "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { "smithy.api#documentation": "[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete\n stack instances for.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
[Service-managed permissions] The Organizations accounts from which to delete\n stack instances.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
The Amazon Web Services Regions where you want to delete StackSet instances.
", "smithy.api#required": {} } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { "smithy.api#documentation": "Preferences for how CloudFormation performs this StackSet operation.
" } }, "RetainStacks": { "target": "com.amazonaws.cloudformation#RetainStacks", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Removes the stack instances from the specified StackSet, but doesn't delete the stacks.\n You can't reassociate a retained stack or add an existing, saved stack to a new stack\n set.
\nFor more information, see StackSet operation options.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique identifier for this StackSet operation.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the StackSet operation only once, even if you retry the request multiple times. You\n can retry StackSet operation requests to ensure that CloudFormation successfully received\n them.
\nRepeating this StackSet operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nThe unique identifier for this StackSet operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DeleteStackSet": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DeleteStackSetInput" }, "output": { "target": "com.amazonaws.cloudformation#DeleteStackSetOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#OperationInProgressException" }, { "target": "com.amazonaws.cloudformation#StackSetNotEmptyException" } ], "traits": { "smithy.api#documentation": "Deletes a StackSet. Before you can delete a StackSet, all its member stack instances must\n be deleted. For more information about how to complete this, see DeleteStackInstances.
" } }, "com.amazonaws.cloudformation#DeleteStackSetInput": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or unique ID of the StackSet that you're deleting. You can obtain this value by\n running ListStackSets.
", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nSpecifies the deployment mode for the stack operation. Possible values are:
\n\n STANDARD - Use the standard deployment behavior, ensuring resources are\n ready to serve traffic before completing the operation. This is the default. You do not need\n to specify this value explicitly.
\n EXPRESS - Complete the stack operation when resource configuration is\n applied, without waiting for resources to become ready to serve traffic. Resources continue\n becoming ready in the background.
Specifies whether to disable rollback of the stack if the stack operation fails.
\nDefault: false\n
The deployment configuration for a stack operation, including the deployment mode.
" } }, "com.amazonaws.cloudformation#DeploymentConfigMode": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } }, "EXPRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPRESS" } } } }, "com.amazonaws.cloudformation#DeploymentMode": { "type": "enum", "members": { "REVERT_DRIFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVERT_DRIFT" } } } }, "com.amazonaws.cloudformation#DeploymentTargets": { "type": "structure", "members": { "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { "smithy.api#documentation": "The Amazon Web Services account IDs where you want to perform stack operations. How these accounts are\n used depends on the AccountFilterType property.
If you have many account numbers, you can provide those accounts using the\n AccountsUrl property instead.
The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file\n format must be either .csv or .txt, and the data can be comma-separated\n or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000\n accounts).
This property serves the same purpose as Accounts but allows you to specify a\n large number of accounts.
The organization root ID or organizational unit (OU) IDs where you want to perform stack\n operations. CloudFormation will perform operations on accounts within these OUs and their child\n OUs.
" } }, "AccountFilterType": { "target": "com.amazonaws.cloudformation#AccountFilterType", "traits": { "smithy.api#documentation": "Refines which accounts will have stack operations performed on them by specifying how to use\n the Accounts and OrganizationalUnitIds properties together.
The following values determine how CloudFormation selects target accounts:
\n\n INTERSECTION: Performs stack operations only on specific individual accounts\n within the selected OUs. Only accounts that are both specified in the Accounts\n property and belong to the specified OUs will be targeted.
\n DIFFERENCE: Performs stack operations on all accounts in the selected OUs\n except for specific accounts listed in the Accounts property. This enables you to\n exclude certain accounts within an OU, such as suspended accounts.
\n UNION: Performs stack operations on the specified OUs plus additional\n individual accounts listed in the Accounts property. This is the default value if\n AccountFilterType is not provided. This lets you target an entire OU and\n individual accounts from a different OU in one request. Note that UNION is not\n supported for CreateStackInstances operations.
\n NONE: Performs stack operations on all accounts in the specified\n organizational units (OUs).
Specifies the Organizations accounts where you want to create, update, or delete\n stack instances. You can target either your entire organization or specific accounts using\n organizational units (OUs) and account filter options.
\nCloudFormation doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU\n in your organization.
\nWhen performing create operations, if you specify both OrganizationalUnitIds\n and Accounts, you must also specify the AccountFilterType property.
Marks an extension or extension version as DEPRECATED in the CloudFormation\n registry, removing it from active use. Deprecated extensions or extension versions cannot be\n used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of\n that extension. If an extension has only a single active version, deregistering that version\n results in the extension itself being deregistered and marked as deprecated in the\n registry.
\nYou can't deregister the default version of an extension if there are other active version\n of that extension. If you do deregister the default version of an extension, the extension\n type itself is deregistered as well and marked as deprecated.
\nTo view the deprecation status of an extension or extension version, use DescribeType.
\nFor more information, see Remove\n third-party private extensions from your account in the\n CloudFormation User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudformation#DeregisterTypeInput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DeregisterTypeOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeAccountLimits": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeAccountLimitsInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeAccountLimitsOutput" }, "traits": { "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you\n can create in your account. For more information about account limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "AccountLimits" } } }, "com.amazonaws.cloudformation#DescribeAccountLimitsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#documentation": "The input for the DescribeAccountLimits action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeAccountLimitsOutput": { "type": "structure", "members": { "AccountLimits": { "target": "com.amazonaws.cloudformation#AccountLimitList", "traits": { "smithy.api#documentation": "An account limit structure that contain a list of CloudFormation account limits and their\n values.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of limits. If\n no additional page exists, this value is null.
" } } }, "traits": { "smithy.api#documentation": "The output for the DescribeAccountLimits action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeChangeSet": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeChangeSetInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeChangeSetOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if\n you execute the change set. For more information, see Update\n CloudFormation stacks using change sets in the\n CloudFormation User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Changes" }, "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], "smithy.waiters#waitable": { "ChangeSetCreateComplete": { "documentation": "Wait until change set status is CREATE_COMPLETE.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "Status", "expected": "CREATE_COMPLETE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "Status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "errorType": "ValidationError" } } ], "minDelay": 30 } } } }, "com.amazonaws.cloudformation#DescribeChangeSetHooks": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeChangeSetHooksInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeChangeSetHooksOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns Hook-related information for the change set and a list of changes that\n CloudFormation makes when you run the change set.
" } }, "com.amazonaws.cloudformation#DescribeChangeSetHooksInput": { "type": "structure", "members": { "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set that you want to describe.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or stack ID (ARN) of the\n change set you want to describe.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#documentation": "If specified, lists only the Hooks related to the specified\n LogicalResourceId.
The change set identifier (stack ID).
" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { "smithy.api#documentation": "The change set name.
" } }, "Hooks": { "target": "com.amazonaws.cloudformation#ChangeSetHooks", "traits": { "smithy.api#documentation": "List of Hook objects.
" } }, "Status": { "target": "com.amazonaws.cloudformation#ChangeSetHooksStatus", "traits": { "smithy.api#documentation": "Provides the status of the change set Hook.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "Pagination token, null or empty if no more results.
The stack identifier (stack ID).
" } }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#documentation": "The stack name.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeChangeSetInput": { "type": "structure", "members": { "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set that you want to describe.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or ID (ARN) of the\n change set you want to describe.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "IncludePropertyValues": { "target": "com.amazonaws.cloudformation#IncludePropertyValues", "traits": { "smithy.api#documentation": "If true, the returned changes include detailed changes in the property\n values.
The input for the DescribeChangeSet action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeChangeSetOutput": { "type": "structure", "members": { "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { "smithy.api#documentation": "The name of the change set.
" } }, "ChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the change set.
" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stack that's associated with the change set.
" } }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#documentation": "The name of the stack that's associated with the change set.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "Information about the change set.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { "smithy.api#documentation": "A list of Parameter structures that describes the input parameters and their\n values used to create the change set. For more information, see the Parameter data type.
The start time when the change set was created, in UTC.
" } }, "ExecutionStatus": { "target": "com.amazonaws.cloudformation#ExecutionStatus", "traits": { "smithy.api#documentation": "If the change set execution status is AVAILABLE, you can execute the change\n set. If you can't execute the change set, the status indicates why. For example, a change set\n might be in an UNAVAILABLE state because CloudFormation is still creating it or in an\n OBSOLETE state because the stack was already updated.
The current status of the change set, such as CREATE_PENDING,\n CREATE_COMPLETE, or FAILED.
A description of the change set's status. For example, if your attempt to create a change\n set failed, CloudFormation shows the error message.
" } }, "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#documentation": "The drift status of the stack when the change set was created. Valid values:
\n\n DRIFTED \u2013 The stack has drifted from its last deployment.
\n IN_SYNC \u2013 The stack is in sync with its last deployment.
\n NOT_CHECKED \u2013 CloudFormation doesn\u2019t currently return this value.
\n UNKNOWN \u2013 The drift status could not be determined.
Only present for drift-aware change sets.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { "smithy.api#documentation": "The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the\n change set.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { "smithy.api#documentation": "If you execute the change set, the list of capabilities that were explicitly acknowledged\n when the change set was created.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { "smithy.api#documentation": "If you execute the change set, the tags that will be associated with the stack.
" } }, "Changes": { "target": "com.amazonaws.cloudformation#Changes", "traits": { "smithy.api#documentation": "A list of Change structures that describes the resources CloudFormation changes\n if you execute the change set.
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is\n no additional page, this value is null.
" } }, "IncludeNestedStacks": { "target": "com.amazonaws.cloudformation#IncludeNestedStacks", "traits": { "smithy.api#documentation": "Verifies if IncludeNestedStacks is set to True.
Specifies the change set ID of the parent change set in the current nested change set\n hierarchy.
" } }, "RootChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { "smithy.api#documentation": "Specifies the change set ID of the root change set in the current nested change set\n hierarchy.
" } }, "OnStackFailure": { "target": "com.amazonaws.cloudformation#OnStackFailure", "traits": { "smithy.api#documentation": "Determines what action will be taken if stack creation fails. When this parameter is\n specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these\n values:
\n DELETE - Deletes the change set if the stack creation fails. This is only\n valid when the ChangeSetType parameter is set to CREATE. If the\n deletion of the stack fails, the status of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent\n to specifying true for the DisableRollback parameter to the\n ExecuteChangeSet API operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is\n equivalent to specifying false for the DisableRollback parameter\n to the ExecuteChangeSet API operation.
Indicates if the change set imports resources that already exist.
\nThis parameter can only import resources that have custom\n names in templates. To import resources that do not accept custom names, such as\n EC2 instances, use the resource import\n feature instead.
\nThe deployment mode specified when the change set was created. Valid value is\n REVERT_DRIFT. Only present for drift-aware change sets.
The deployment configuration specified when the change set was created.
" } } }, "traits": { "smithy.api#documentation": "The output for the DescribeChangeSet action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeEvents": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeEventsInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeEventsOutput" }, "traits": { "smithy.api#documentation": "Returns CloudFormation events based on flexible query criteria. Groups events by operation ID,\n enabling you to focus on individual stack operations during deployment.
\nAn operation is any action performed on a stack, including stack lifecycle actions\n (Create, Update, Delete, Rollback), change set creation, nested stack creation, and automatic\n rollbacks triggered by failures. Each operation has a unique identifier (Operation ID) and\n represents a discrete change attempt on the stack.
\nReturns different types of events including:
\n\n Progress events - Status updates during stack operation\n execution.
\n\n Validation errors - Failures from CloudFormation Early\n Validations.
\n\n Provisioning errors - Resource creation and update\n failures.
\n\n Hook invocation errors - Failures from CloudFormation\n Hook during stack operations.
\nOne of ChangeSetName, OperationId or StackName\n must be specified as input.
The name or unique stack ID for which you want to retrieve events. If you specified the\n name of a change set, specify the stack name or ID (ARN) of the change set you want to\n describe.
" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set for which you want to retrieve\n events.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#OperationId", "traits": { "smithy.api#documentation": "The unique identifier of the operation for which you want to retrieve events.
" } }, "Filters": { "target": "com.amazonaws.cloudformation#EventFilter", "traits": { "smithy.api#documentation": "Filters to apply when retrieving events.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeEventsOutput": { "type": "structure", "members": { "OperationEvents": { "target": "com.amazonaws.cloudformation#OperationEvents", "traits": { "smithy.api#documentation": "A list of operation events that match the specified criteria.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call DescribeEvents again and\n assign that token to the request object's NextToken parameter. If the request\n returns all results, NextToken is set to null.
Describes a generated template. The output includes details about the progress of the\n creation of a generated template started by a CreateGeneratedTemplate API action\n or the update of a generated template started with an UpdateGeneratedTemplate API\n action.
The name or Amazon Resource Name (ARN) of a generated template.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeGeneratedTemplateOutput": { "type": "structure", "members": { "GeneratedTemplateId": { "target": "com.amazonaws.cloudformation#GeneratedTemplateId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}.\n For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
The name of the generated template.
" } }, "Resources": { "target": "com.amazonaws.cloudformation#ResourceDetails", "traits": { "smithy.api#documentation": "A list of objects describing the details of the resources in the template\n generation.
" } }, "Status": { "target": "com.amazonaws.cloudformation#GeneratedTemplateStatus", "traits": { "smithy.api#documentation": "The status of the template generation. Supported values are:
\n\n CreatePending - the creation of the template is pending.
\n CreateInProgress - the creation of the template is in progress.
\n DeletePending - the deletion of the template is pending.
\n DeleteInProgress - the deletion of the template is in progress.
\n UpdatePending - the update of the template is pending.
\n UpdateInProgress - the update of the template is in progress.
\n Failed - the template operation failed.
\n Complete - the template operation is complete.
The reason for the current template generation status. This will provide more details if a\n failure happened.
" } }, "CreationTime": { "target": "com.amazonaws.cloudformation#CreationTime", "traits": { "smithy.api#documentation": "The time the generated template was created.
" } }, "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { "smithy.api#documentation": "The time the generated template was last updated.
" } }, "Progress": { "target": "com.amazonaws.cloudformation#TemplateProgress", "traits": { "smithy.api#documentation": "An object describing the progress of the template generation.
" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "The stack ARN of the base stack if a base stack was provided when generating the\n template.
" } }, "TemplateConfiguration": { "target": "com.amazonaws.cloudformation#TemplateConfiguration", "traits": { "smithy.api#documentation": "The configuration details of the generated template, including the\n DeletionPolicy and UpdateReplacePolicy.
The number of warnings generated for this template. The warnings are found in the details\n of each of the resources in the template.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeOrganizationsAccess": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeOrganizationsAccessInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeOrganizationsAccessOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#InvalidOperationException" }, { "target": "com.amazonaws.cloudformation#OperationNotFoundException" } ], "traits": { "smithy.api#documentation": "Retrieves information about the account's OrganizationAccess status. This API\n can be called either by the management account or the delegated administrator by using the\n CallAs parameter. This API can also be called without the CallAs\n parameter by the management account.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nPresents the status of the OrganizationAccess.
Returns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension\n publisher, DescribePublisher returns information about your own publisher\n account.
For more information about registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing extensions\n to make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide\n
\nThe ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension\n publisher, DescribePublisher returns information about your own publisher\n account.
The ID of the extension publisher.
" } }, "PublisherStatus": { "target": "com.amazonaws.cloudformation#PublisherStatus", "traits": { "smithy.api#documentation": "Whether the publisher is verified. Currently, all registered publishers are\n verified.
" } }, "IdentityProvider": { "target": "com.amazonaws.cloudformation#IdentityProvider", "traits": { "smithy.api#documentation": "The type of account used as the identity provider when registering this publisher with\n CloudFormation.
" } }, "PublisherProfile": { "target": "com.amazonaws.cloudformation#PublisherProfile", "traits": { "smithy.api#documentation": "The URL to the publisher's profile with the identity provider.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeResourceScan": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeResourceScanInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeResourceScanOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#ResourceScanNotFoundException" } ], "traits": { "smithy.api#documentation": "Describes details of a resource scan.
" } }, "com.amazonaws.cloudformation#DescribeResourceScanInput": { "type": "structure", "members": { "ResourceScanId": { "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource scan.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeResourceScanOutput": { "type": "structure", "members": { "ResourceScanId": { "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An\n example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .
Status of the resource scan.
\nThe resource scan is still in progress.
\nThe resource scan is complete.
\nThe resource scan has expired.
\nThe resource scan has failed.
\nThe reason for the resource scan status, providing more information if a failure\n happened.
" } }, "StartTime": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The time that the resource scan was started.
" } }, "EndTime": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The time that the resource scan was finished.
" } }, "PercentageCompleted": { "target": "com.amazonaws.cloudformation#PercentageCompleted", "traits": { "smithy.api#documentation": "The percentage of the resource scan that has been completed.
" } }, "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { "smithy.api#documentation": "The list of resource types for the specified scan. Resource types are only available for\n scans with a Status set to COMPLETE or FAILED .
The number of resources that were listed. This is only available for scans with a\n Status set to COMPLETE, EXPIRED, or FAILED\n .
The number of resources that were read. This is only available for scans with a\n Status set to COMPLETE, EXPIRED, or\n FAILED.
This field may be 0 if the resource scan failed with a\n ResourceScanLimitExceededException.
The scan filters that were used.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput" }, "traits": { "smithy.api#documentation": "Returns information about a stack drift detection operation. A stack drift detection\n operation detects whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. A stack is considered to have\n drifted if one or more of its resources have drifted. For more information about stack and\n resource drift, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to\n monitor the progress of the operation using DescribeStackDriftDetectionStatus.\n Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.
The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of drift results CloudFormation retains for any given stack, and for\n how long, may vary.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the stack.
", "smithy.api#required": {} } }, "StackDriftDetectionId": { "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of reports CloudFormation retains for any given stack, and for how\n long, may vary.
", "smithy.api#required": {} } }, "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A\n stack is considered to have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its\n expected template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.
\n UNKNOWN: CloudFormation could not run drift detection for a resource in the\n stack. See the DetectionStatusReason for details.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE: The stack drift detection operation has successfully\n completed for all resources in the stack that support drift detection. (Resources that\n don't currently support stack detection remain unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack\n drift detection operation, only the resources with those logical IDs are checked for\n drift.
\n\n DETECTION_FAILED: The stack drift detection operation has failed for at\n least one resource in the stack. Results will be available for resources on which\n CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS: The stack drift detection operation is currently\n in progress.
The reason the stack drift detection operation has its current status.
" } }, "DriftedStackResourceCount": { "target": "com.amazonaws.cloudformation#BoxedInteger", "traits": { "smithy.api#documentation": "Total number of stack resources that have drifted. This is NULL until the drift detection\n operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks\n whose drift status is IN_SYNC.
Time at which the stack drift detection operation was initiated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeStackEvents": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeStackEventsInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeStackEventsOutput" }, "traits": { "smithy.api#documentation": "Returns all stack related events for a specified stack in reverse chronological order. For\n more information about a stack's event history, see Understand CloudFormation stack creation events in the\n CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by\n specifying the unique stack identifier (stack ID).
\nThe name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nThe token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#documentation": "The input for DescribeStackEvents action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeStackEventsOutput": { "type": "structure", "members": { "StackEvents": { "target": "com.amazonaws.cloudformation#StackEvents", "traits": { "smithy.api#documentation": "A list of StackEvents structures.
If the output exceeds 1 MB in size, a string that identifies the next page of events. If\n no additional page exists, this value is null.
" } } }, "traits": { "smithy.api#documentation": "The output for a DescribeStackEvents action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeStackInstance": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeStackInstanceInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeStackInstanceOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" }, { "target": "com.amazonaws.cloudformation#StackSetNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account,\n and Amazon Web Services Region.
\nFor a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" } }, "com.amazonaws.cloudformation#DescribeStackInstanceInput": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or the unique stack ID of the StackSet that you want to get stack instance\n information for.
", "smithy.api#required": {} } }, "StackInstanceAccount": { "target": "com.amazonaws.cloudformation#Account", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of an Amazon Web Services account that's associated with this stack instance.
", "smithy.api#required": {} } }, "StackInstanceRegion": { "target": "com.amazonaws.cloudformation#Region", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of a Region that's associated with this stack instance.
", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nThe stack instance that matches the specified request parameters.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeStackRefactor": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeStackRefactorInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeStackRefactorOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#StackRefactorNotFoundException" } ], "traits": { "smithy.api#documentation": "Describes the stack refactor status.
", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], "smithy.waiters#waitable": { "StackRefactorCreateComplete": { "documentation": "Wait until the stack refactor status is CREATE_COMPLETE.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "Status", "expected": "CREATE_COMPLETE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "Status", "expected": "CREATE_FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "errorType": "ValidationError" } } ], "minDelay": 5 }, "StackRefactorExecuteComplete": { "documentation": "Wait until the stack refactor status is EXECUTE_COMPLETE.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "ExecutionStatus", "expected": "EXECUTE_COMPLETE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "ExecutionStatus", "expected": "EXECUTE_FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "ExecutionStatus", "expected": "ROLLBACK_COMPLETE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "errorType": "ValidationError" } } ], "minDelay": 15 } } } }, "com.amazonaws.cloudformation#DescribeStackRefactorInput": { "type": "structure", "members": { "StackRefactorId": { "target": "com.amazonaws.cloudformation#StackRefactorId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID associated with the stack refactor created from the CreateStackRefactor action.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeStackRefactorOutput": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "A description to help you identify the refactor.
" } }, "StackRefactorId": { "target": "com.amazonaws.cloudformation#StackRefactorId", "traits": { "smithy.api#documentation": "The ID associated with the stack refactor created from the CreateStackRefactor action.
" } }, "StackIds": { "target": "com.amazonaws.cloudformation#StackIds", "traits": { "smithy.api#documentation": "The unique ID for each stack.
" } }, "ExecutionStatus": { "target": "com.amazonaws.cloudformation#StackRefactorExecutionStatus", "traits": { "smithy.api#documentation": "The stack refactor execution operation status that's provided after calling the ExecuteStackRefactor action.
" } }, "ExecutionStatusReason": { "target": "com.amazonaws.cloudformation#ExecutionStatusReason", "traits": { "smithy.api#documentation": "A detailed explanation for the stack refactor ExecutionStatus.
The stack refactor operation status that's provided after calling the CreateStackRefactor action.
" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#StackRefactorStatusReason", "traits": { "smithy.api#documentation": "A detailed explanation for the stack refactor operation Status.
Returns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90 days\n after the stack has been deleted.
" } }, "com.amazonaws.cloudformation#DescribeStackResourceDrifts": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsOutput" }, "traits": { "smithy.api#documentation": "Returns drift information for the resources that have been checked for drift in the\n specified stack. This includes actual and expected configuration values for resources where\n CloudFormation detects configuration drift.
\nFor a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n aren't included. Resources that don't currently support drift detection aren't checked, and so\n not included. For a list of resources that support drift detection, see Resource\n type support for imports and drift detection.
Use DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all supported resources for a given\n stack.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#DescribeStackResourceDriftsInput": { "type": "structure", "members": { "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the stack for which you want drift information.
", "smithy.api#required": {} } }, "StackResourceDriftStatusFilters": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", "traits": { "smithy.api#documentation": "The resource drift status values to use as filters for the resource drift results\n returned.
\n\n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
\n UNKNOWN: CloudFormation could not run drift detection for the\n resource.
The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#BoxedMaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
Drift information for the resources that have been checked for drift in the specified\n stack. This includes actual and expected configuration values for resources where CloudFormation\n detects drift.
\nFor a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n aren't included. Resources that do not currently support drift detection aren't checked, and\n so not included. For a list of resources that support drift detection, see Resource\n type support for imports and drift detection.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call DescribeStackResourceDrifts\n again and assign that token to the request object's NextToken parameter. If the\n request returns all results, NextToken is set to null.
The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nThe logical name of the resource as specified in the template.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The input for DescribeStackResource action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeStackResourceOutput": { "type": "structure", "members": { "StackResourceDetail": { "target": "com.amazonaws.cloudformation#StackResourceDetail", "traits": { "smithy.api#documentation": "A StackResourceDetail structure that contains the description of the\n specified resource in the specified stack.
The output for a DescribeStackResource action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeStackResources": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeStackResourcesInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeStackResourcesOutput" }, "traits": { "smithy.api#documentation": "Returns Amazon Web Services resource descriptions for running and deleted stacks. If\n StackName is specified, all the associated resources that are part of the stack\n are returned. If PhysicalResourceId is specified, the associated resources of the\n stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than\n this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for\n up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not\n both. In addition, you can specify LogicalResourceId to filter the returned\n result. For more information about resources, the LogicalResourceId and\n PhysicalResourceId, see the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName\n and PhysicalResourceId in the same request.
The name or the unique stack ID that is associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The logical name of the resource as specified in the template.
" } }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance,\n PhysicalResourceId corresponds to the InstanceId. You can pass the\n EC2 InstanceId to DescribeStackResources to find which stack the\n instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you must\n specify StackName.
The input for DescribeStackResources action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeStackResourcesOutput": { "type": "structure", "members": { "StackResources": { "target": "com.amazonaws.cloudformation#StackResources", "traits": { "smithy.api#documentation": "A list of StackResource structures.
The output for a DescribeStackResources action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeStackSet": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeStackSetInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeStackSetOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#StackSetNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns the description of the specified StackSet.
\nThis API provides strongly consistent reads meaning it will always\n return the most up-to-date data.
\nThe name or unique ID of the StackSet whose description you want.
", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nReturns the description of the specified StackSet operation.
\nReports role provisioning and stack instances deployment progress in StatusDetails.Stages. A breakdown for each Amazon Web Services Region is available in RegionalStatusDetails.
This API provides strongly consistent reads meaning it will always\n return the most up-to-date data.
\nThe name or the unique stack ID of the StackSet for the stack operation.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique ID of the StackSet operation.
", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nThe specified StackSet operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeStackSetOutput": { "type": "structure", "members": { "StackSet": { "target": "com.amazonaws.cloudformation#StackSet", "traits": { "smithy.api#documentation": "The specified StackSet.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeStacks": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeStacksInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeStacksOutput" }, "traits": { "smithy.api#documentation": "Returns the description for the specified stack; if no stack name was specified, then it\n returns the description for all the stacks created. For more information about a stack's event\n history, see Understand CloudFormation stack creation events in the\n CloudFormation User Guide.
\nIf the stack doesn't exist, a ValidationError is returned.
If you don't pass a parameter to StackName, the API returns a response\n that describes all resources in the account, which can impact performance. This requires\n ListStacks and DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to\n StackName.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the\n request:
\n{ \"Version\": \"2012-10-17\",\t\t \t \t \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }]\n }
\nThe name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nThe token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#documentation": "The input for DescribeStacks action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeStacksOutput": { "type": "structure", "members": { "Stacks": { "target": "com.amazonaws.cloudformation#Stacks", "traits": { "smithy.api#documentation": "A list of stack structures.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.
" } } }, "traits": { "smithy.api#documentation": "The output for a DescribeStacks action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeType": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeTypeInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeTypeOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CFNRegistryException" }, { "target": "com.amazonaws.cloudformation#TypeNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns detailed information about an extension from the CloudFormation registry in your\n current account and Region.
\nIf you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.
For more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudformation#DescribeTypeInput": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { "smithy.api#documentation": "The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
\nIf you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.
The publisher ID of the extension publisher.
\nExtensions provided by Amazon Web Services are not assigned a publisher ID.
" } }, "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { "smithy.api#documentation": "The version number of a public third-party extension.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeTypeOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
" } }, "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { "smithy.api#documentation": "The kind of extension.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias,\n CloudFormation returns the type name alias. For more information, see ActivateType.
" } }, "DefaultVersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the\n extension version isn't specified.
\nThis applies only to private extensions you have registered in your account. For public\n extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns\n null. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and\n extensions published by Amazon Web Services. For public third-party extensions, whether they are activated\n in your account, CloudFormation returns null.
The contract test status of the registered extension version. To return the extension test\n status of a specific extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
\n\n PASSED: The extension has passed all its contract tests.
An extension must have a test status of PASSED before it can be\n published. For more information, see Publishing\n extensions to make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the\n extension.
\n NOT_TESTED: Contract tests haven't been performed on the\n extension.
The description of the test status. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "The description of the extension.
" } }, "Schema": { "target": "com.amazonaws.cloudformation#TypeSchema", "traits": { "smithy.api#documentation": "The schema that defines the extension.
\nFor more information, see Resource type\n schema in the CloudFormation Command Line Interface (CLI) User Guide and the CloudFormation Hooks User Guide.
" } }, "ProvisioningType": { "target": "com.amazonaws.cloudformation#ProvisioningType", "traits": { "smithy.api#documentation": "For resource type extensions, the provisioning behavior of the resource type. CloudFormation\n determines the provisioning type during registration, based on the types of handlers in the\n schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process\n updates to the type during stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the\n type can't be updated and must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include all the following\n handlers, and therefore can't actually be provisioned.
create
\nread
\ndelete
\nThe deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in\n CloudFormation operations, dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no\n longer be used in CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
Contains logging configuration information for private extensions. This applies only to\n private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For\n more information, see RegisterType.
For extensions that are modules, the public third-party extensions that must be activated\n in your account in order for the module itself to be activated.
" } }, "ExecutionRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension.\n This applies only to private extensions you have registered in your account. For more\n information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution\n role\n that includes the necessary permissions to call those Amazon Web Services APIs,\n and provision that execution role in your account. CloudFormation then assumes that execution role\n to provide your extension with the appropriate credentials.
" } }, "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { "smithy.api#documentation": "The scope at which the extension is visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: The extension is only visible and usable within the account in\n which it is registered. CloudFormation marks any extensions you register as\n PRIVATE.
\n PUBLIC: The extension is publicly visible and usable within any Amazon Web Services\n account.
The URL of the source code for the extension.
" } }, "DocumentationUrl": { "target": "com.amazonaws.cloudformation#OptionalSecureUrl", "traits": { "smithy.api#documentation": "The URL of a page providing detailed documentation for this extension.
" } }, "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see\n RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For\n more information, see ActivateType.
\nWhen the specified private extension version was registered or activated in your\n account.
" } }, "ConfigurationSchema": { "target": "com.amazonaws.cloudformation#ConfigurationSchema", "traits": { "smithy.api#documentation": "A JSON string that represent the current configuration data for the extension in this\n account and Region.
\nTo set the configuration data for an extension, use SetTypeConfiguration.
" } }, "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { "smithy.api#documentation": "The publisher ID of the extension publisher.
\nThis applies only to public third-party extensions. For private registered extensions, and\n extensions provided by Amazon Web Services, CloudFormation returns null.
For public extensions that have been activated for this account and Region, the type name\n of the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the account and\n Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the Amazon\n Resource Name (ARN) of the public extension.
" } }, "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { "smithy.api#documentation": "The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or\n specify a public extension without specifying a version. For all other extensions, CloudFormation\n returns null.
The latest version of a public extension that is available for\n use.
\nThis only applies if you specify a public extension, and you don't specify a version. For\n all other requests, CloudFormation returns null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation\n returns null.
Whether CloudFormation automatically updates the extension in this account and Region when a\n new minor version is published by the extension publisher. Major versions\n released by the publisher must be manually updated. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DescribeTypeRegistration": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DescribeTypeRegistrationInput" }, "output": { "target": "com.amazonaws.cloudformation#DescribeTypeRegistrationOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CFNRegistryException" } ], "traits": { "smithy.api#documentation": "Returns information about an extension's registration, including its current status and\n type and version identifiers.
\nWhen you initiate a registration request using RegisterType, you can\n then use DescribeTypeRegistration to monitor the progress of that\n registration request.
\nOnce the registration request has completed, use DescribeType to return\n detailed information about an extension.
", "smithy.api#idempotent": {}, "smithy.waiters#waitable": { "TypeRegistrationComplete": { "documentation": "Wait until type registration is COMPLETE.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "ProgressStatus", "expected": "COMPLETE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "ProgressStatus", "expected": "FAILED", "comparator": "stringEquals" } } } ], "minDelay": 30 } } } }, "com.amazonaws.cloudformation#DescribeTypeRegistrationInput": { "type": "structure", "members": { "RegistrationToken": { "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration\n request using RegisterType.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DescribeTypeRegistrationOutput": { "type": "structure", "members": { "ProgressStatus": { "target": "com.amazonaws.cloudformation#RegistrationStatus", "traits": { "smithy.api#documentation": "The current status of the extension registration request.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "The description of the extension registration request.
" } }, "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than\n COMPLETE, this will be null.
The Amazon Resource Name (ARN) of this specific version of the extension being\n registered.
\nFor registration requests with a ProgressStatus of other than\n COMPLETE, this will be null.
Detects whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. For each resource in the stack that\n supports drift detection, CloudFormation compares the actual configuration of the resource with\n its expected template configuration. Only resource properties explicitly defined in the stack\n template are checked for drift. A stack is considered to have drifted if one or more of its\n resources differ from their expected template configurations. For more information, see Detect unmanaged configuration changes to stacks and resources with drift\n detection.
\nUse DetectStackDrift to detect drift on all supported resources for a given\n stack, or DetectStackResourceDrift to detect drift on individual\n resources.
For a list of stack resources that currently support drift detection, see Resource\n type support for imports and drift detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of\n resources contained within the stack. Use DescribeStackDriftDetectionStatus\n to monitor the progress of a detect stack drift operation. Once the drift detection operation\n has completed, use DescribeStackResourceDrifts to return drift information\n about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks\n belonging to that stack. Perform DetectStackDrift directly on the nested stack\n itself.
The name of the stack for which you want to detect drift.
", "smithy.api#required": {} } }, "LogicalResourceIds": { "target": "com.amazonaws.cloudformation#LogicalResourceIds", "traits": { "smithy.api#documentation": "The logical names of any resources you want to use as filters.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DetectStackDriftOutput": { "type": "structure", "members": { "StackDriftDetectionId": { "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of drift results CloudFormation retains for any given stack, and for\n how long, may vary.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DetectStackResourceDrift": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DetectStackResourceDriftInput" }, "output": { "target": "com.amazonaws.cloudformation#DetectStackResourceDriftOutput" }, "traits": { "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. This information includes actual and\n expected property values for resources in which CloudFormation detects drift. Only resource\n properties explicitly defined in the stack template are checked for drift. For more\n information about stack and resource drift, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all resources in a given stack that\n support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of\n resources that support drift detection, see Resource\n type support for imports and drift detection.
" } }, "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { "type": "structure", "members": { "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the stack to which the resource belongs.
", "smithy.api#required": {} } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The logical name of the resource for which to return drift information.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#DetectStackResourceDriftOutput": { "type": "structure", "members": { "StackResourceDrift": { "target": "com.amazonaws.cloudformation#StackResourceDrift", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Information about whether the resource's actual configuration has drifted from its\n expected template configuration, including actual and expected property values and any\n differences detected.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DetectStackSetDrift": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#DetectStackSetDriftInput" }, "output": { "target": "com.amazonaws.cloudformation#DetectStackSetDriftOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#InvalidOperationException" }, { "target": "com.amazonaws.cloudformation#OperationInProgressException" }, { "target": "com.amazonaws.cloudformation#StackSetNotFoundException" } ], "traits": { "smithy.api#documentation": "Detect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it\n performs drift detection on the stack associated with each stack instance in the StackSet. For\n more information, see Performing drift detection on\n CloudFormation StackSets.
\n\n DetectStackSetDrift returns the OperationId of the StackSet\n drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection\n operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the StackSet, in addition to the number of resources included in each\n stack.
Once the operation has completed, use the following actions to return drift\n information:
\nUse DescribeStackSet to return detailed information about the stack\n set, including detailed information about the last completed drift\n operation performed on the StackSet. (Information about drift operations that are in\n progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging\n to the StackSet, including the drift status and last drift time checked of each\n instance.
\nUse DescribeStackInstance to return detailed information about a\n specific stack instance, including its drift status and last drift time checked.
\nYou can only run a single drift detection operation on a given StackSet at one\n time.
\nTo stop a drift detection StackSet operation, use StopStackSetOperation.
" } }, "com.amazonaws.cloudformation#DetectStackSetDriftInput": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the StackSet on which to perform the drift detection operation.
", "smithy.api#required": {} } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a StackSet operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "\n The ID of the StackSet operation.\n
", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nThe ID of the drift detection StackSet operation.
\nYou can use this operation ID with DescribeStackSetOperation to monitor\n the progress of the drift detection operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#DetectionReason": { "type": "string" }, "com.amazonaws.cloudformation#DifferenceType": { "type": "enum", "members": { "ADD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADD" } }, "REMOVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REMOVE" } }, "NOT_EQUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_EQUAL" } } } }, "com.amazonaws.cloudformation#DisableRollback": { "type": "boolean" }, "com.amazonaws.cloudformation#DisableValidation": { "type": "boolean", "traits": { "smithy.api#documentation": "Boolean to enable or disable pre-deployment validations in changeset and stack operations:
\n\n true: disable pre-deployment validations.
\n false: enable pre-deployment validations.
Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple\n Monthly Calculator URL with a query string that describes the resources required to run the\n template.
" } }, "com.amazonaws.cloudformation#EstimateTemplateCostInput": { "type": "structure", "members": { "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "Structure that contains the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must pass TemplateBody or TemplateURL. If both\n are passed, only TemplateBody is used.
The URL of a file that contains the template body. The URL must point to a template that's\n located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must\n start with https://. URLs from S3 static websites are not supported.
Conditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.
A list of Parameter structures that specify input parameters.
The input for an EstimateTemplateCost action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#EstimateTemplateCostOutput": { "type": "structure", "members": { "Url": { "target": "com.amazonaws.cloudformation#Url", "traits": { "smithy.api#documentation": "An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources\n required to run the template.
" } } }, "traits": { "smithy.api#documentation": "The output for a EstimateTemplateCost action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#EvaluationType": { "type": "enum", "members": { "Static": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Static" } }, "Dynamic": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Dynamic" } } } }, "com.amazonaws.cloudformation#EventFilter": { "type": "structure", "members": { "FailedEvents": { "target": "com.amazonaws.cloudformation#FailedEventsFilter", "traits": { "smithy.api#documentation": "When set to true, only returns failed events within the operation. This helps quickly\n identify root causes for a failed operation.
" } } }, "traits": { "smithy.api#documentation": "Event filter allows you to focus on specific events in an operation.
" } }, "com.amazonaws.cloudformation#EventId": { "type": "string" }, "com.amazonaws.cloudformation#EventType": { "type": "enum", "members": { "STACK_EVENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STACK_EVENT" } }, "PROGRESS_EVENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROGRESS_EVENT" } }, "VALIDATION_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION_ERROR" } }, "PROVISIONING_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONING_ERROR" } }, "HOOK_INVOCATION_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOOK_INVOCATION_ERROR" } } } }, "com.amazonaws.cloudformation#ExecuteChangeSet": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ExecuteChangeSetInput" }, "output": { "target": "com.amazonaws.cloudformation#ExecuteChangeSetOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" }, { "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" }, { "target": "com.amazonaws.cloudformation#InvalidChangeSetStatusException" }, { "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" } ], "traits": { "smithy.api#documentation": "Updates a stack using the input information that was provided when the specified change\n set was created. After the call successfully completes, CloudFormation starts updating the stack.\n Use the DescribeStacks action to view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with\n the stack because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the\n update. You can't specify a temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks\n must have been set to True.
The name or Amazon Resource Name (ARN) of the change set that you want use to update the\n specified stack.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or Amazon Resource Name\n (ARN) that's associated with the change set you want to execute.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "A unique identifier for this ExecuteChangeSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to execute a\n change set to update a stack with the same name. You might retry ExecuteChangeSet\n requests to ensure that CloudFormation successfully received them.
Preserves the state of previously provisioned resources when an operation fails. This\n parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.
\n True - if the stack creation fails, do nothing. This is equivalent to\n specifying DO_NOTHING for the OnStackFailure parameter to the\n CreateChangeSet API operation.
\n False - if the stack creation fails, roll back the stack. This is\n equivalent to specifying ROLLBACK for the OnStackFailure\n parameter to the CreateChangeSet API operation.
Default: True\n
When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
The input for the ExecuteChangeSet action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ExecuteChangeSetOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The output for the ExecuteChangeSet action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#ExecuteStackRefactor": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ExecuteStackRefactorInput" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Executes the stack refactor operation.
" } }, "com.amazonaws.cloudformation#ExecuteStackRefactorInput": { "type": "structure", "members": { "StackRefactorId": { "target": "com.amazonaws.cloudformation#StackRefactorId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID associated with the stack refactor created from the CreateStackRefactor action.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ExecutionRoleName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z_0-9+=,.@-]+$" } }, "com.amazonaws.cloudformation#ExecutionStatus": { "type": "enum", "members": { "UNAVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNAVAILABLE" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "EXECUTE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXECUTE_IN_PROGRESS" } }, "EXECUTE_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXECUTE_COMPLETE" } }, "EXECUTE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXECUTE_FAILED" } }, "OBSOLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OBSOLETE" } } } }, "com.amazonaws.cloudformation#ExecutionStatusReason": { "type": "string" }, "com.amazonaws.cloudformation#Export": { "type": "structure", "members": { "ExportingStackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "The stack that contains the exported output name and value.
" } }, "Name": { "target": "com.amazonaws.cloudformation#ExportName", "traits": { "smithy.api#documentation": "The name of exported output value. Use this name and the Fn::ImportValue\n function to import the associated value into other stacks. The name is defined in the\n Export field in the associated stack's Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in\n the Export field in the associated stack's Outputs section.
The Export structure describes the exported output values for a stack.
For more information, see Get exported outputs from\n a deployed CloudFormation stack.
" } }, "com.amazonaws.cloudformation#ExportName": { "type": "string" }, "com.amazonaws.cloudformation#ExportValue": { "type": "string" }, "com.amazonaws.cloudformation#Exports": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#Export" } }, "com.amazonaws.cloudformation#FailedAccountsCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#FailedEventsFilter": { "type": "boolean" }, "com.amazonaws.cloudformation#FailedStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#FailureToleranceCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#FailureTolerancePercentage": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.cloudformation#ForceRollback": { "type": "boolean" }, "com.amazonaws.cloudformation#GeneratedTemplateDeletionPolicy": { "type": "enum", "members": { "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } }, "RETAIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETAIN" } } } }, "com.amazonaws.cloudformation#GeneratedTemplateId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.cloudformation#GeneratedTemplateName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "GeneratedTemplateNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The generated template was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudformation#GeneratedTemplateResourceStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } } } }, "com.amazonaws.cloudformation#GeneratedTemplateStatus": { "type": "enum", "members": { "CREATE_PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_PENDING" } }, "UPDATE_PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_PENDING" } }, "DELETE_PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_PENDING" } }, "CREATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, "UPDATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_IN_PROGRESS" } }, "DELETE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } } } }, "com.amazonaws.cloudformation#GeneratedTemplateUpdateReplacePolicy": { "type": "enum", "members": { "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } }, "RETAIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETAIN" } } } }, "com.amazonaws.cloudformation#GetGeneratedTemplate": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#GetGeneratedTemplateInput" }, "output": { "target": "com.amazonaws.cloudformation#GetGeneratedTemplateOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException" } ], "traits": { "smithy.api#documentation": "Retrieves a generated template. If the template is in an InProgress or\n Pending status then the template returned will be the template when the\n template was last in a Complete status. If the template has not yet been in a\n Complete status then an empty template will be returned.
The language to use to retrieve for the generated template. Supported values are:
\n\n JSON\n
\n YAML\n
The name or Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}.\n For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
The status of the template generation. Supported values are:
\n\n CreatePending - the creation of the template is pending.
\n CreateInProgress - the creation of the template is in progress.
\n DeletePending - the deletion of the template is pending.
\n DeleteInProgress - the deletion of the template is in progress.
\n UpdatePending - the update of the template is pending.
\n UpdateInProgress - the update of the template is in progress.
\n Failed - the template operation failed.
\n Complete - the template operation is complete.
The template body of the generated template, in the language specified by the\n Language parameter.
Retrieves detailed information and remediation guidance for a Hook invocation\n result.
\nIf the Hook uses a KMS key to encrypt annotations, callers of the\n GetHookResult operation must have kms:Decrypt permissions. For\n more information, see KMS key policy\n and permissions for encrypting CloudFormation Hooks results at rest in the\n CloudFormation Hooks User Guide.
The unique identifier (ID) of the Hook invocation result that you want details about.\n You can get the ID from the ListHookResults\n operation.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#GetHookResultOutput": { "type": "structure", "members": { "HookResultId": { "target": "com.amazonaws.cloudformation#HookInvocationId", "traits": { "smithy.api#documentation": "The unique identifier of the Hook result.
" } }, "InvocationPoint": { "target": "com.amazonaws.cloudformation#HookInvocationPoint", "traits": { "smithy.api#documentation": "The specific point in the provisioning process where the Hook is invoked.
" } }, "FailureMode": { "target": "com.amazonaws.cloudformation#HookFailureMode", "traits": { "smithy.api#documentation": "The failure mode of the invocation.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#HookTypeName", "traits": { "smithy.api#documentation": "The name of the Hook that was invoked.
" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#HookTypeName", "traits": { "smithy.api#documentation": "The original public type name of the Hook when an alias is used.
\nFor example, if you activate AWS::Hooks::GuardHook with alias\n MyCompany::Custom::GuardHook, then TypeName will be\n MyCompany::Custom::GuardHook and OriginalTypeName will be\n AWS::Hooks::GuardHook.
The version identifier of the Hook that was invoked.
" } }, "TypeConfigurationVersionId": { "target": "com.amazonaws.cloudformation#HookTypeConfigurationVersionId", "traits": { "smithy.api#documentation": "The version identifier of the Hook configuration data that was used during\n invocation.
" } }, "TypeArn": { "target": "com.amazonaws.cloudformation#HookTypeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Hook.
" } }, "Status": { "target": "com.amazonaws.cloudformation#HookStatus", "traits": { "smithy.api#documentation": "The status of the Hook invocation. The following statuses are possible:
\n\n HOOK_IN_PROGRESS: The Hook is currently running.
\n HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.
\n HOOK_COMPLETE_FAILED: The Hook completed but failed validation.
\n HOOK_FAILED: The Hook encountered an error during execution.
A message that provides additional details about the Hook invocation status.
" } }, "InvokedAt": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the Hook was invoked.
" } }, "Target": { "target": "com.amazonaws.cloudformation#HookTarget", "traits": { "smithy.api#documentation": "Information about the target of the Hook invocation.
" } }, "Annotations": { "target": "com.amazonaws.cloudformation#AnnotationList", "traits": { "smithy.api#documentation": "A list of objects with additional information and guidance that can help you resolve a\n failed Hook invocation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#GetStackPolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#GetStackPolicyInput" }, "output": { "target": "com.amazonaws.cloudformation#GetStackPolicyOutput" }, "traits": { "smithy.api#documentation": "Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null\n value is returned.
" } }, "com.amazonaws.cloudformation#GetStackPolicyInput": { "type": "structure", "members": { "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or unique stack ID that's associated with the stack whose policy you want to\n get.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The input for the GetStackPolicy action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#GetStackPolicyOutput": { "type": "structure", "members": { "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { "smithy.api#documentation": "Structure that contains the stack policy body. For more information, see Prevent updates to stack resources in the\n CloudFormation User Guide.
" } } }, "traits": { "smithy.api#documentation": "The output for the GetStackPolicy action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#GetTemplate": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#GetTemplateInput" }, "output": { "target": "com.amazonaws.cloudformation#GetTemplateOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns the template body for a specified stack. You can get the template for running or\n deleted stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after\n the stack has been deleted.
If the template doesn't exist, a ValidationError is returned.
The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nThe name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the\n associated template. If you specify a name, you must also specify the\n StackName.
For templates that include transforms, the stage of the template that CloudFormation returns.\n To get the user-submitted template, specify Original. To get the template after\n CloudFormation has processed all transforms, specify Processed.
If the template doesn't include transforms, Original and\n Processed return the same template. By default, CloudFormation specifies\n Processed.
The input for a GetTemplate action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#GetTemplateOutput": { "type": "structure", "members": { "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "Structure that contains the template body.
\nCloudFormation returns the same template that was used when the stack was created.
" } }, "StagesAvailable": { "target": "com.amazonaws.cloudformation#StageList", "traits": { "smithy.api#documentation": "The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the\n Original template is always available. After CloudFormation finishes creating the\n change set, the Processed template becomes available.
The output for GetTemplate action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#GetTemplateSummary": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#GetTemplateSummaryInput" }, "output": { "target": "com.amazonaws.cloudformation#GetTemplateSummaryOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#StackSetNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns information about a new or existing template. The GetTemplateSummary\n action is useful for viewing parameter information, such as default parameter values and\n parameter types, before you create or update a stack or StackSet.
You can use the GetTemplateSummary action when you submit a template, or you\n can get template information for a StackSet, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for\n up to 90 days after the stack has been deleted. If the template doesn't exist, a\n ValidationError is returned.
Structure that contains the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
The URL of a file that contains the template body. The URL must point to a template (max\n size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for\n an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always\n interchangeable. For running stacks, you can specify either the stack's name or its unique\n stack ID. For deleted stack, you must specify the unique stack ID.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
The name or unique ID of the StackSet from which the stack was created.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nSpecifies options for the GetTemplateSummary API action.
The input for the GetTemplateSummary action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#GetTemplateSummaryOutput": { "type": "structure", "members": { "Parameters": { "target": "com.amazonaws.cloudformation#ParameterDeclarations", "traits": { "smithy.api#documentation": "A list of parameter declarations that describe various properties for each\n parameter.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "The value that's defined in the Description property of the template.
The capabilities found within the template. If your template contains IAM resources, you\n must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for\n this parameter when you use the CreateStack or UpdateStack\n actions with your template; otherwise, those actions return an\n InsufficientCapabilities error.
For more information, see Acknowledging IAM resources in CloudFormation templates.
" } }, "CapabilitiesReason": { "target": "com.amazonaws.cloudformation#CapabilitiesReason", "traits": { "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response\n element.
A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and\n Custom::MyCustomInstance.
The Amazon Web Services template format version, which identifies the capabilities of the\n template.
" } }, "Metadata": { "target": "com.amazonaws.cloudformation#Metadata", "traits": { "smithy.api#documentation": "The value that's defined for the Metadata property of the template.
A list of the transforms that are declared in the template.
" } }, "ResourceIdentifierSummaries": { "target": "com.amazonaws.cloudformation#ResourceIdentifierSummaries", "traits": { "smithy.api#documentation": "A list of resource identifier summaries that describe the target resources of an import\n operation and the properties you can provide during the import to identify the target\n resources. For example, BucketName is a possible identifier property for an\n AWS::S3::Bucket resource.
An object that contains any warnings returned.
" } } }, "traits": { "smithy.api#documentation": "The output for the GetTemplateSummary action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#HandlerErrorCode": { "type": "enum", "members": { "NotUpdatable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotUpdatable" } }, "InvalidRequest": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidRequest" } }, "AccessDenied": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AccessDenied" } }, "InvalidCredentials": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidCredentials" } }, "AlreadyExists": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AlreadyExists" } }, "NotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotFound" } }, "ResourceConflict": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceConflict" } }, "Throttling": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Throttling" } }, "ServiceLimitExceeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ServiceLimitExceeded" } }, "ServiceTimeout": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotStabilized" } }, "GeneralServiceException": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GeneralServiceException" } }, "ServiceInternalError": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ServiceInternalError" } }, "NetworkFailure": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkFailure" } }, "InternalFailure": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InternalFailure" } }, "InvalidTypeConfiguration": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidTypeConfiguration" } }, "HandlerInternalFailure": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HandlerInternalFailure" } }, "NonCompliant": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NonCompliant" } }, "Unknown": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unknown" } }, "UnsupportedTarget": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UnsupportedTarget" } } } }, "com.amazonaws.cloudformation#HookFailureMode": { "type": "enum", "members": { "FAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAIL" } }, "WARN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WARN" } } } }, "com.amazonaws.cloudformation#HookInvocationCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.cloudformation#HookInvocationId": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, "com.amazonaws.cloudformation#HookInvocationPoint": { "type": "enum", "members": { "PRE_PROVISION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_PROVISION" } } } }, "com.amazonaws.cloudformation#HookResultId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1600 }, "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, "com.amazonaws.cloudformation#HookResultNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "HookResultNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified target doesn't have any requested Hook invocations.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudformation#HookResultSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#HookResultSummary" } }, "com.amazonaws.cloudformation#HookResultSummary": { "type": "structure", "members": { "HookResultId": { "target": "com.amazonaws.cloudformation#HookInvocationId", "traits": { "smithy.api#documentation": "The unique identifier for this Hook invocation result.
" } }, "InvocationPoint": { "target": "com.amazonaws.cloudformation#HookInvocationPoint", "traits": { "smithy.api#documentation": "The specific point in the provisioning process where the Hook is invoked.
" } }, "FailureMode": { "target": "com.amazonaws.cloudformation#HookFailureMode", "traits": { "smithy.api#documentation": "The failure mode of the invocation.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#HookTypeName", "traits": { "smithy.api#documentation": "The name of the Hook that was invoked.
" } }, "TypeVersionId": { "target": "com.amazonaws.cloudformation#HookTypeVersionId", "traits": { "smithy.api#documentation": "The version of the Hook that was invoked.
" } }, "TypeConfigurationVersionId": { "target": "com.amazonaws.cloudformation#HookTypeConfigurationVersionId", "traits": { "smithy.api#documentation": "The version of the Hook configuration.
" } }, "Status": { "target": "com.amazonaws.cloudformation#HookStatus", "traits": { "smithy.api#documentation": "The status of the Hook invocation. The following statuses are possible:
\n\n HOOK_IN_PROGRESS: The Hook is currently running.
\n HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.
\n HOOK_COMPLETE_FAILED: The Hook completed but failed validation.
\n HOOK_FAILED: The Hook encountered an error during execution.
A description of the Hook results status. For example, if the Hook result is in a failed\n state, this may contain additional information for the failed state.
" } }, "InvokedAt": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the Hook was invoked.
\nOnly shown in responses when the request does not specify TargetType and\n TargetId filters.
The target type that the Hook was invoked against.
" } }, "TargetId": { "target": "com.amazonaws.cloudformation#HookResultId", "traits": { "smithy.api#documentation": "The unique identifier of the Hook invocation target.
" } }, "TypeArn": { "target": "com.amazonaws.cloudformation#HookTypeArn", "traits": { "smithy.api#documentation": "The ARN of the Hook that was invoked.
" } }, "HookExecutionTarget": { "target": "com.amazonaws.cloudformation#HookResultId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API\n operation.
\nOnly shown in responses when the request does not specify TargetType and\n TargetId filters.
A ListHookResults call returns a summary of a Hook invocation.
The target type.
", "smithy.api#required": {} } }, "TargetTypeName": { "target": "com.amazonaws.cloudformation#HookTargetTypeName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The target name, for example, AWS::S3::Bucket.
The unique identifier of the Hook invocation target.
", "smithy.api#required": {} } }, "Action": { "target": "com.amazonaws.cloudformation#HookTargetAction", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The action that invoked the Hook.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The HookTarget data type.
Import existing stacks into a new StackSets. Use the stack import operation to import up\n to 10 stacks into a new StackSet in the same account as the source stack or in a different\n administrator account and Region, by specifying the stack ID of the stack you intend to\n import.
" } }, "com.amazonaws.cloudformation#ImportStacksToStackSetInput": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the StackSet. The name must be unique in the Region where you create your\n StackSet.
", "smithy.api#required": {} } }, "StackIds": { "target": "com.amazonaws.cloudformation#StackIdList", "traits": { "smithy.api#documentation": "The IDs of the stacks you are importing into a StackSet. You import up to 10 stacks per\n StackSet at a time.
\nSpecify either StackIds or StackIdsUrl.
The Amazon S3 URL which contains list of stack ids to be inputted.
\nSpecify either StackIds or StackIdsUrl.
The list of OU ID's to which the imported stacks must be mapped as deployment\n targets.
" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a StackSet operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "A unique, user defined, identifier for the StackSet operation.
", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
For service managed StackSets, specify DELEGATED_ADMIN.
The unique identifier for the StackSet operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#Imports": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackName" } }, "com.amazonaws.cloudformation#InProgressStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#InSyncStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#IncludeNestedStacks": { "type": "boolean" }, "com.amazonaws.cloudformation#IncludePropertyValues": { "type": "boolean" }, "com.amazonaws.cloudformation#InsufficientCapabilitiesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InsufficientCapabilitiesException", "httpResponseCode": 400 }, "smithy.api#documentation": "The template contains resources with capabilities that weren't specified in the Capabilities parameter.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#InvalidChangeSetStatusException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidChangeSetStatus", "httpResponseCode": 400 }, "smithy.api#documentation": "The specified change set can't be used to update the stack. For example, the change set status might be\n CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.
The specified operation isn't valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#InvalidStateTransitionException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidStateTransition", "httpResponseCode": 400 }, "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI. CloudFormation doesn't\n return this error to users.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#IsActivated": { "type": "boolean" }, "com.amazonaws.cloudformation#IsDefaultConfiguration": { "type": "boolean" }, "com.amazonaws.cloudformation#IsDefaultVersion": { "type": "boolean" }, "com.amazonaws.cloudformation#JazzLogicalResourceIds": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#LogicalResourceId" }, "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.cloudformation#JazzResourceIdentifierProperties": { "type": "map", "key": { "target": "com.amazonaws.cloudformation#JazzResourceIdentifierPropertyKey" }, "value": { "target": "com.amazonaws.cloudformation#JazzResourceIdentifierPropertyValue" } }, "com.amazonaws.cloudformation#JazzResourceIdentifierPropertyKey": { "type": "string" }, "com.amazonaws.cloudformation#JazzResourceIdentifierPropertyValue": { "type": "string" }, "com.amazonaws.cloudformation#Key": { "type": "string" }, "com.amazonaws.cloudformation#LastOperations": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#OperationEntry" } }, "com.amazonaws.cloudformation#LastUpdatedTime": { "type": "timestamp" }, "com.amazonaws.cloudformation#LimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "LimitExceededException", "httpResponseCode": 400 }, "smithy.api#documentation": "The quota for the resource has already been reached.
\nFor information about resource and stack limitations, see CloudFormation quotas in the\n CloudFormation User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#LimitName": { "type": "string" }, "com.amazonaws.cloudformation#LimitValue": { "type": "integer" }, "com.amazonaws.cloudformation#ListChangeSets": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ListChangeSetsInput" }, "output": { "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" }, "traits": { "smithy.api#documentation": "Returns the ID and status of each active change set for a stack. For example, CloudFormation\n lists change sets that are in the CREATE_IN_PROGRESS or\n CREATE_PENDING state.
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change\n sets.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#documentation": "The input for the ListChangeSets action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListChangeSetsOutput": { "type": "structure", "members": { "Summaries": { "target": "com.amazonaws.cloudformation#ChangeSetSummaries", "traits": { "smithy.api#documentation": "A list of ChangeSetSummary structures that provides the ID and status of each\n change set for the specified stack.
If the output exceeds 1 MB, a string that identifies the next page of change sets. If\n there is no additional page, this value is null.
The output for the ListChangeSets action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#ListExports": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ListExportsInput" }, "output": { "target": "com.amazonaws.cloudformation#ListExportsOutput" }, "traits": { "smithy.api#documentation": "Lists all exported output values in the account and Region in which you call this action.\n Use this action to see the exported output values that you can import into other stacks. To\n import values, use the Fn::ImportValue function.
\nFor more information, see Get exported outputs\n from a deployed CloudFormation stack.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Exports" } } }, "com.amazonaws.cloudformation#ListExportsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListExportsOutput": { "type": "structure", "members": { "Exports": { "target": "com.amazonaws.cloudformation#Exports", "traits": { "smithy.api#documentation": "The output for the ListExports action.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "If the output exceeds 100 exported output values, a string that identifies the next page\n of exports. If there is no additional page, this value is null.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#ListGeneratedTemplates": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ListGeneratedTemplatesInput" }, "output": { "target": "com.amazonaws.cloudformation#ListGeneratedTemplatesOutput" }, "traits": { "smithy.api#documentation": "Lists your generated templates in this Region.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Summaries", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListGeneratedTemplatesInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. By default the ListGeneratedTemplates API action\n will return at most 50 results in each response. The maximum value is 100.
A list of summaries of the generated templates.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListGeneratedTemplates again\n and use that value for the NextToken parameter. If the request returns all\n results, NextToken is set to an empty string.
Returns summaries of invoked Hooks. For more information, see View invocation\n summaries for CloudFormation Hooks in the CloudFormation Hooks User Guide.
\nThis operation supports the following parameter combinations:
\nNo parameters: Returns all Hook invocation summaries.
\n\n TypeArn only: Returns summaries for a specific Hook.
\n TypeArn and Status: Returns summaries for a specific Hook\n filtered by status.
\n TargetId and TargetType: Returns summaries for a specific\n Hook invocation target.
Filters results by target type. Currently, only CHANGE_SET and\n CLOUD_CONTROL are supported filter options.
Required when TargetId is specified and cannot be used otherwise.
Filters results by the unique identifier of the target the Hook was invoked\n against.
\nFor change sets, this is the change set ARN. When the target is a Cloud Control API operation, this\n value must be the HookRequestToken returned by the Cloud Control API request. For more\n information on the HookRequestToken, see ProgressEvent.
Required when TargetType is specified and cannot be used otherwise.
Filters results by the ARN of the Hook. Can be used alone or in combination with\n Status.
Filters results by the status of Hook invocations. Can only be used in combination with\n TypeArn. Valid values are:
\n HOOK_IN_PROGRESS: The Hook is currently running.
\n HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.
\n HOOK_COMPLETE_FAILED: The Hook completed but failed validation.
\n HOOK_FAILED: The Hook encountered an error during execution.
The token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListHookResultsOutput": { "type": "structure", "members": { "TargetType": { "target": "com.amazonaws.cloudformation#ListHookResultsTargetType", "traits": { "smithy.api#documentation": "The target type.
" } }, "TargetId": { "target": "com.amazonaws.cloudformation#HookResultId", "traits": { "smithy.api#documentation": "The unique identifier of the Hook invocation target.
" } }, "HookResults": { "target": "com.amazonaws.cloudformation#HookResultSummaries", "traits": { "smithy.api#documentation": "A list of HookResultSummary structures that provides the status and Hook\n status reason for each Hook invocation for the specified target.
Pagination token, null or empty if no more results.
Lists all stacks that are importing an exported output value. To modify or remove an\n exported output value, first use this action to see which stacks are using it. To see the\n exported output values in your account, see ListExports.
\nFor more information about importing an exported output value, see the Fn::ImportValue function.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Imports" } } }, "com.amazonaws.cloudformation#ListImportsInput": { "type": "structure", "members": { "ExportName": { "target": "com.amazonaws.cloudformation#ExportName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are\n importing this value.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListImportsOutput": { "type": "structure", "members": { "Imports": { "target": "com.amazonaws.cloudformation#Imports", "traits": { "smithy.api#documentation": "A list of stack names that are importing the specified exported output value.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "A string that identifies the next page of exports. If there is no additional page, this\n value is null.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#ListResourceScanRelatedResources": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesInput" }, "output": { "target": "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#ResourceScanInProgressException" }, { "target": "com.amazonaws.cloudformation#ResourceScanNotFoundException" } ], "traits": { "smithy.api#documentation": "Lists the related resources for a list of resources from a resource scan. The response\n indicates whether each returned resource is already managed by CloudFormation.
", "smithy.api#examples": [ { "title": "To list resource scan related resources", "documentation": "This example lists the resources related to the passed in resources", "input": { "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", "Resources": [ { "ResourceType": "AWS::S3::Bucket", "ResourceIdentifier": { "BucketName": "jazz-bucket" } }, { "ResourceType": "AWS::EC2::DHCPOptions", "ResourceIdentifier": { "DhcpOptionsId": "random-id123" } } ] }, "output": { "RelatedResources": [ { "ResourceType": "AWS::EC2::VPCDHCPOptionsAssociation", "ResourceIdentifier": { "VpcId": "vpc-0123456abcdefg", "DhcpOptionsId": "dopt-98765edcba" }, "ManagedByStack": false }, { "ResourceType": "AWS::EC2::VPC", "ResourceIdentifier": { "VpcId": "vpc-0123456abcdefgabc" }, "ManagedByStack": false }, { "ResourceType": "AWS::EC2::VPCDHCPOptionsAssociation", "ResourceIdentifier": { "VpcId": "vpc-123456abcdef", "DhcpOptionsId": "dopt-98765edcba" }, "ManagedByStack": false }, { "ResourceType": "AWS::EC2::VPC", "ResourceIdentifier": { "VpcId": "vpc-12345678abcd" }, "ManagedByStack": false } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RelatedResources", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesInput": { "type": "structure", "members": { "ResourceScanId": { "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource scan.
", "smithy.api#required": {} } }, "Resources": { "target": "com.amazonaws.cloudformation#ScannedResourceIdentifiers", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The list of resources for which you want to get the related resources. Up to 100 resources\n can be provided.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#BoxedMaxResults", "traits": { "smithy.api#documentation": "If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. By default the ListResourceScanRelatedResources API\n action will return up to 100 results in each response. The maximum value is 100.
List of up to MaxResults resources in the specified resource scan related to\n the specified resources.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call\n ListResourceScanRelatedResources again and use that value for the\n NextToken parameter. If the request returns all results, NextToken\n is set to an empty string.
Lists the resources from a resource scan. The results can be filtered by resource\n identifier, resource type prefix, tag key, and tag value. Only resources that match all\n specified filters are returned. The response indicates whether each returned resource is\n already managed by CloudFormation.
", "smithy.api#examples": [ { "title": "To list the resources in your resource scan", "documentation": "This example lists the resources in your resource scan", "input": { "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1" }, "output": { "Resources": [ { "ResourceType": "AWS::Amplify::App", "ResourceIdentifier": { "Arn": "arn:aws:amplify:us-east-1:123456789012:apps/12345678" }, "ManagedByStack": false }, { "ResourceType": "AWS::ApiGateway::Deployment", "ResourceIdentifier": { "DeploymentId": "1234567", "RestApiId": "abcdefgh" }, "ManagedByStack": true } ], "NextToken": "AQICAHjOiFofVZCZ0aEN1VnF1m9jq/xxpTY7MyPexz72BHuAkgETVS8c+PVCFpE6uGVJDxCFAAACbjCCAmoGCSqGSIb3DQEHBqCCAlswggJXAgEAMIICUAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAwJ9QJAYeDzUoBeimECARCAggIh8brcL6H6uMvcZafRTB79hUkdJlOoFavrhYA2U7qdlPUwyvaVqN2DvFMxsl2XC1SaWmr5esMKxg1fLjbOEF32lVQn0Jp8QuoFUvREnqEsR32ZQmiI/Oc9HmwIr/BS3rzljki2Kr8Y0nriS7aFDLUCYsdsRdQ9iL5/iCc6oW7IisCzq1VKcHijlXvuiEipZAinsxEbmYBjmWgT7UYZdrrb6Hq3COEgPzS490ucndtwPjyvuCIMiAfTLMuBgjkzEfp4U97aLwPWaiKw94dMXj/3K67uuH9BjWZO+j6d3nnyZ14FOgI7SQvvVBnxARbTmINttHWjXPrIuE9YuuSWgn6GmuzEEDqkuglOS/OeTHYSPvLPRrFieUiawblljLVoVY9/HDjL/EErSTWiCnytGXIRoMI9Ozp2Yjfm3MBwSDXvMIrscw6QAa3bUA6uJSV2skCBnDoqV8EXd8umh788OgEtDxQ7d/NlUYEhN6AJ0K9TVz/2rZgOlzLCmtvmbIy7loAZCmf/uPNkyu6WuoLWTzQz78SnA8jWPKnxrzhNyPuaIgUH23U3mExhfMRDczitpOo5JM81oHVPECslGoqktLhP55BQqMbJy4w16SZJfr993TXhF5jOZenRN1zDsK3J5cLdJgPK1Ds1Z9DnRKMfXOqoAyme2l94/h0kLIxgAtxOeJFP/g/9hUtt1qGkZeV3Xqw1nkFQnafGIg4fJoWg74Sr7yo=" } }, { "title": "To list the resources in your resource scan for specific resource type", "documentation": "This example lists the resources in your resource scan filtering only the resources that start with the passed in prefix", "input": { "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", "ResourceTypePrefix": "AWS::S3" }, "output": { "Resources": [ { "ResourceType": "AWS::S3::AccessPoint", "ResourceIdentifier": { "Name": "test-access-point" }, "ManagedByStack": true }, { "ResourceType": "AWS::S3::BucketPolicy", "ResourceIdentifier": { "Bucket": "a-random-bucket" }, "ManagedByStack": false } ], "NextToken": "AQICAHjOiFofVZCZ0aEN1VnF1m9jq/xxpTY7MyPexz72BHuAkgETVS8c+PVCFpE6uGVJDxCFAAACbjCCAmoGCSqGSIb3DQEHBqCCAlswggJXAgEAMIICUAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAwJ9QJAYeDzUoBeimECARCAggIh8brcL6H6uMvcZafRTB79hUkdJlOoFavrhYA2U7qdlPUwyvaVqN2DvFMxsl2XC1SaWmr5esMKxg1fLjbOEF32lVQn0Jp8QuoFUvREnqEsR32ZQmiI/Oc9HmwIr/BS3rzljki2Kr8Y0nriS7aFDLUCYsdsRdQ9iL5/iCc6oW7IisCzq1VKcHijlXvuiEipZAinsxEbmYBjmWgT7UYZdrrb6Hq3COEgPzS490ucndtwPjyvuCIMiAfTLMuBgjkzEfp4U97aLwPWaiKw94dMXj/3K67uuH9BjWZO+j6d3nnyZ14FOgI7SQvvVBnxARbTmINttHWjXPrIuE9YuuSWgn6GmuzEEDqkuglOS/OeTHYSPvLPRrFieUiawblljLVoVY9/HDjL/EErSTWiCnytGXIRoMI9Ozp2Yjfm3MBwSDXvMIrscw6QAa3bUA6uJSV2skCBnDoqV8EXd8umh788OgEtDxQ7d/NlUYEhN6AJ0K9TVz/2rZgOlzLCmtvmbIy7loAZCmf/uPNkyu6WuoLWTzQz78SnA8jWPKnxrzhNyPuaIgUH23U3mExhfMRDczitpOo5JM81oHVPECslGoqktLhP55BQqMbJy4w16SZJfr993TXhF5jOZenRN1zDsK3J5cLdJgPK1Ds1Z9DnRKMfXOqoAyme2l94/h0kLIxgAtxOeJFP/g/9hUtt1qGkZeV3Xqw1nkFQnafGIg4fJoWg74Sr7yo=" } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Resources", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListResourceScanResourcesInput": { "type": "structure", "members": { "ResourceScanId": { "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource scan.
", "smithy.api#required": {} } }, "ResourceIdentifier": { "target": "com.amazonaws.cloudformation#ResourceIdentifier", "traits": { "smithy.api#documentation": "If specified, the returned resources will have the specified resource identifier (or one\n of them in the case where the resource has multiple identifiers).
" } }, "ResourceTypePrefix": { "target": "com.amazonaws.cloudformation#ResourceTypePrefix", "traits": { "smithy.api#documentation": "If specified, the returned resources will be of any of the resource types with the\n specified prefix.
" } }, "TagKey": { "target": "com.amazonaws.cloudformation#TagKey", "traits": { "smithy.api#documentation": "If specified, the returned resources will have a matching tag key.
" } }, "TagValue": { "target": "com.amazonaws.cloudformation#TagValue", "traits": { "smithy.api#documentation": "If specified, the returned resources will have a matching tag value.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", "traits": { "smithy.api#documentation": "If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. By default the ListResourceScanResources API action\n will return at most 100 results in each response. The maximum value is 100.
List of up to MaxResults resources in the specified resource scan that match\n all of the specified filters.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListResourceScanResources\n again and use that value for the NextToken parameter. If the request returns all\n results, NextToken is set to an empty string.
List the resource scans from newest to oldest. By default it will return up to 10 resource\n scans.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ResourceScanSummaries", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListResourceScansInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", "traits": { "smithy.api#documentation": "If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. The default value is 10. The maximum value is 100.
The scan type that you want to get summary information about. The default is\n FULL.
The list of scans returned.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListResourceScans again and\n use that value for the NextToken parameter. If the request returns all results,\n NextToken is set to an empty string.
Returns drift information for resources in a stack instance.
\n\n ListStackInstanceResourceDrifts returns drift information for the most\n recent drift detection operation. If an operation is in progress, it may only return partial\n results.
The name or unique ID of the StackSet that you want to list drifted resources for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The resource drift status of the stack instance.
\n\n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The name of the Amazon Web Services account that you want to list resource drifts for.
", "smithy.api#required": {} } }, "StackInstanceRegion": { "target": "com.amazonaws.cloudformation#Region", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Region where you want to list resource drifts.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique ID of the drift operation.
", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of StackInstanceResourceDriftsSummary structures that contain\n information about the specified stack instances.
If the previous paginated request didn't return all of the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.
Returns summary information about stack instances that are associated with the specified\n StackSet. You can filter for stack instances that are associated with a specific Amazon Web Services account\n name or Region, or that have a specific status.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Summaries", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListStackInstancesInput": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or unique ID of the StackSet that you want to list stack instances for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The filter to apply to stack instances
" } }, "StackInstanceAccount": { "target": "com.amazonaws.cloudformation#Account", "traits": { "smithy.api#documentation": "The name of the Amazon Web Services account that you want to list stack instances for.
" } }, "StackInstanceRegion": { "target": "com.amazonaws.cloudformation#Region", "traits": { "smithy.api#documentation": "The name of the Region where you want to list stack instances.
" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of StackInstanceSummary structures that contain information about the\n specified stack instances.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListStackInstances again and\n assign that token to the request object's NextToken parameter. If the request\n returns all results, NextToken is set to null.
Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "StackRefactorActions", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListStackRefactorActionsInput": { "type": "structure", "members": { "StackRefactorId": { "target": "com.amazonaws.cloudformation#StackRefactorId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID associated with the stack refactor created from the CreateStackRefactor action.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The stack refactor actions.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
Lists all account stack refactor operations and their statuses.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "StackRefactorSummaries", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListStackRefactorsInput": { "type": "structure", "members": { "ExecutionStatusFilter": { "target": "com.amazonaws.cloudformation#StackRefactorExecutionStatusFilter", "traits": { "smithy.api#documentation": "Execution status to use as a filter. Specify one or more execution status codes to list\n only stack refactors with the specified execution status codes.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
Provides a summary of a stack refactor, including the following:
\n\n StackRefactorId\n
\n Status\n
\n StatusReason\n
\n ExecutionStatus\n
\n ExecutionStatusReason\n
\n Description\n
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
Returns descriptions of all resources of the specified stack.
\nFor deleted stacks, ListStackResources returns resource information for up to 90 days\n after the stack has been deleted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "StackResourceSummaries" } } }, "com.amazonaws.cloudformation#ListStackResourcesInput": { "type": "structure", "members": { "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nThe token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#documentation": "The input for the ListStackResource action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListStackResourcesOutput": { "type": "structure", "members": { "StackResourceSummaries": { "target": "com.amazonaws.cloudformation#StackResourceSummaries", "traits": { "smithy.api#documentation": "A list of StackResourceSummary structures.
If the output exceeds 1 MB, a string that identifies the next page of stack resources. If\n no additional page exists, this value is null.
" } } }, "traits": { "smithy.api#documentation": "The output for a ListStackResources action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#ListStackSetAutoDeploymentTargets": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ListStackSetAutoDeploymentTargetsInput" }, "output": { "target": "com.amazonaws.cloudformation#ListStackSetAutoDeploymentTargetsOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#StackSetNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns summary information about deployment targets for a StackSet.
" } }, "com.amazonaws.cloudformation#ListStackSetAutoDeploymentTargetsInput": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or unique ID of the StackSet that you want to get automatic deployment targets\n for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nAn array of summaries of the deployment targets for the StackSet.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the\n NextToken parameter. If the request returns all results, NextToken\n is set to an empty string.
Returns summary information about the results of a StackSet operation.
\nThis API provides eventually consistent reads meaning it may take\n some time but will eventually return the most up-to-date data.
\nThe name or unique ID of the StackSet that you want to get operation results for.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the StackSet operation.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nThe filter to apply to operation results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListStackSetOperationResultsOutput": { "type": "structure", "members": { "Summaries": { "target": "com.amazonaws.cloudformation#StackSetOperationResultSummaries", "traits": { "smithy.api#documentation": "A list of StackSetOperationResultSummary structures that contain information\n about the specified operation results, for accounts and Amazon Web Services Regions that are included in the\n operation.
If the request doesn't return all results, NextToken is set to a token. To\n retrieve the next set of results, call ListOperationResults again and assign that\n token to the request object's NextToken parameter. If there are no remaining\n results, NextToken is set to null.
Returns summary information about operations performed on a StackSet.
\nReports role provisioning and stack instances deployment progress in StatusDetails.Stages. The breakdown for each Amazon Web Services Region is available only from DescribeStackSetOperation.
This API provides eventually consistent reads meaning it may take\n some time but will eventually return the most up-to-date data.
\nThe name or unique ID of the StackSet that you want to get operation summaries for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of StackSetOperationSummary structures that contain summary\n information about operations for the specified StackSet.
If the request doesn't return all results, NextToken is set to a token. To\n retrieve the next set of results, call ListOperationResults again and assign that\n token to the request object's NextToken parameter. If there are no remaining\n results, NextToken is set to null.
Returns summary information about StackSets that are associated with the user.
\nThis API provides strongly consistent reads meaning it will always\n return the most up-to-date data.
\n[Self-managed permissions] If you set the CallAs parameter to\n SELF while signed in to your Amazon Web Services account, ListStackSets\n returns all self-managed StackSets in your Amazon Web Services account.
[Service-managed permissions] If you set the CallAs parameter to\n SELF while signed in to the organization's management account,\n ListStackSets returns all StackSets in the management account.
[Service-managed permissions] If you set the CallAs parameter to\n DELEGATED_ADMIN while signed in to your member account,\n ListStackSets returns all StackSets with service-managed permissions in the\n management account.
The token for the next set of items to return. (You received this token from a previous call.)
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The status of the StackSets that you want to get summary information about.
" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the management account or as a delegated administrator in a member\n account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of StackSetSummary structures that contain information about the\n user's StackSets.
If the request doesn't return all of the remaining results, NextToken is set\n to a token. To retrieve the next set of results, call ListStackInstances again\n and assign that token to the request object's NextToken parameter. If the request\n returns all results, NextToken is set to null.
Returns the summary information for stacks whose status matches the specified\n StackStatusFilter. Summary information for stacks that have been deleted is\n kept for 90 days after the stack is deleted. If no StackStatusFilter is\n specified, summary information for all stacks is returned (including existing stacks and\n stacks that have been deleted).
The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "StackStatusFilter": { "target": "com.amazonaws.cloudformation#StackStatusFilter", "traits": { "smithy.api#documentation": "Stack status to use as a filter. Specify one or more stack status codes to list only\n stacks with the specified status codes. For a complete list of stack status codes, see the\n StackStatus parameter of the Stack data type.
The input for ListStacks action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListStacksOutput": { "type": "structure", "members": { "StackSummaries": { "target": "com.amazonaws.cloudformation#StackSummaries", "traits": { "smithy.api#documentation": "A list of StackSummary structures that contains information about the\n specified stacks.
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.
" } } }, "traits": { "smithy.api#documentation": "The output for ListStacks action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#ListTypeRegistrations": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ListTypeRegistrationsInput" }, "output": { "target": "com.amazonaws.cloudformation#ListTypeRegistrationsOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CFNRegistryException" } ], "traits": { "smithy.api#documentation": "Returns a list of registration tokens for the specified extension(s).
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListTypeRegistrationsInput": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { "smithy.api#documentation": "The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The current status of the extension registration request.
\nThe default is IN_PROGRESS.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListTypeRegistrationsOutput": { "type": "structure", "members": { "RegistrationTokenList": { "target": "com.amazonaws.cloudformation#RegistrationTokenList", "traits": { "smithy.api#documentation": "A list of extension registration tokens.
\nUse DescribeTypeRegistration to return detailed information about a type\n registration request.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
Returns summary information about the versions of an extension.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListTypeVersionsInput": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { "smithy.api#documentation": "The kind of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary\n information.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The token for the next set of items to return. (You received this token from a previous\n call.)
" } }, "DeprecatedStatus": { "target": "com.amazonaws.cloudformation#DeprecatedStatus", "traits": { "smithy.api#documentation": "The deprecation status of the extension versions that you want to get summary information\n about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation\n operations, dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer\n be used in CloudFormation operations.
The default is LIVE.
The publisher ID of the extension publisher.
\nExtensions published by Amazon aren't assigned a publisher ID.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListTypeVersionsOutput": { "type": "structure", "members": { "TypeVersionSummaries": { "target": "com.amazonaws.cloudformation#TypeVersionSummaries", "traits": { "smithy.api#documentation": "A list of TypeVersionSummary structures that contain information about the\n specified extension's versions.
If the request doesn't return all of the remaining results, NextToken is set\n to a token. To retrieve the next set of results, call this action again and assign that token\n to the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
Returns summary information about all extensions, including your private resource types,\n modules, and Hooks as well as all public extensions from Amazon Web Services and third-party\n publishers.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "TypeSummaries", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudformation#ListTypesInput": { "type": "structure", "members": { "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { "smithy.api#documentation": "The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and\n Region. This includes:
Private extensions you have registered in this account and Region.
\nPublic extensions that you have activated in this account and Region.
\n\n PUBLIC: Extensions that are publicly visible and available to be\n activated within any Amazon Web Services account. This includes extensions from Amazon Web Services and third-party\n publishers.
The default is PRIVATE.
For resource types, the provisioning behavior of the resource type. CloudFormation determines\n the provisioning type during registration, based on the types of handlers in the schema\n handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process\n updates to the type during stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the\n type can't be updated and must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include create, read, and\n delete handlers, and therefore can't actually be provisioned.
The default is FULLY_MUTABLE.
The deprecation status of the extension that you want to get summary information\n about.
\nValid values include:
\n\n LIVE: The extension is registered for use in CloudFormation\n operations.
\n DEPRECATED: The extension has been deregistered and can no longer be used\n in CloudFormation operations.
The type of extension.
" } }, "Filters": { "target": "com.amazonaws.cloudformation#TypeFilters", "traits": { "smithy.api#documentation": "Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For\n example, specifying AWS_TYPES for Category and PRIVATE\n for Visibility returns an empty list of types, but specifying PUBLIC\n for Visibility returns the desired list.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The token for the next set of items to return. (You received this token from a previous\n call.)
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ListTypesOutput": { "type": "structure", "members": { "TypeSummaries": { "target": "com.amazonaws.cloudformation#TypeSummaries", "traits": { "smithy.api#documentation": "A list of TypeSummary structures that contain information about the specified\n extensions.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
The configuration value from the previous CloudFormation deployment.
" } }, "ActualValue": { "target": "com.amazonaws.cloudformation#ResourceDriftActualValue", "traits": { "smithy.api#documentation": "The current live configuration value of the resource property.
" } }, "DriftDetectionTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when drift was detected for this resource property.
" } } }, "traits": { "smithy.api#documentation": "Contains drift information for a resource property, including actual value, previous\n deployment value, and drift detection timestamp.
" } }, "com.amazonaws.cloudformation#LogGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" } }, "com.amazonaws.cloudformation#LoggingConfig": { "type": "structure", "members": { "LogRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log\n entries to CloudWatch Logs.
", "smithy.api#required": {} } }, "LogGroupName": { "target": "com.amazonaws.cloudformation#LogGroupName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the\n extension's handlers.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains logging configuration information for an extension.
" } }, "com.amazonaws.cloudformation#LogicalIdHierarchy": { "type": "string" }, "com.amazonaws.cloudformation#LogicalResourceId": { "type": "string" }, "com.amazonaws.cloudformation#LogicalResourceIds": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#LogicalResourceId" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.cloudformation#MajorVersion": { "type": "long", "traits": { "smithy.api#range": { "min": 1, "max": 100000 } } }, "com.amazonaws.cloudformation#ManagedByStack": { "type": "boolean" }, "com.amazonaws.cloudformation#ManagedExecution": { "type": "structure", "members": { "Active": { "target": "com.amazonaws.cloudformation#ManagedExecutionNullable", "traits": { "smithy.api#documentation": "When true, CloudFormation performs non-conflicting operations concurrently and\n queues conflicting operations. After conflicting operations finish, CloudFormation starts queued\n operations in request order.
If there are already running or queued operations, CloudFormation queues all incoming\n operations even if they are non-conflicting.
\nYou can't modify your StackSet's execution configuration while there are running or queued\n operations for that StackSet.
\nWhen false (default), StackSets performs one operation at a time in request\n order.
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" } }, "com.amazonaws.cloudformation#ManagedExecutionNullable": { "type": "boolean" }, "com.amazonaws.cloudformation#MaxConcurrentCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.cloudformation#MaxConcurrentPercentage": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.cloudformation#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.cloudformation#Metadata": { "type": "string" }, "com.amazonaws.cloudformation#ModuleInfo": { "type": "structure", "members": { "TypeHierarchy": { "target": "com.amazonaws.cloudformation#TypeHierarchy", "traits": { "smithy.api#documentation": "A concatenated list of the module type or types that contains the resource. Module types are\n listed starting with the inner-most nested module, and separated by /.
In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.
\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n
A concatenated list of the logical IDs of the module or modules that contains the resource.\n Modules are listed starting with the inner-most nested module, and separated by\n /.
In the following example, the resource was created from a module, moduleA,\n that's nested inside a parent module, moduleB.
\n moduleA/moduleB\n
For more information, see Reference module resources in\n CloudFormation templates in the CloudFormation User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
\nFor more information about modules, see Create reusable resource configurations\n that can be included across templates with CloudFormation modules in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#MonitoringTimeInMinutes": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 180 } } }, "com.amazonaws.cloudformation#NameAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "NameAlreadyExistsException", "httpResponseCode": 409 }, "smithy.api#documentation": "The specified name is already in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudformation#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.cloudformation#NoEcho": { "type": "boolean" }, "com.amazonaws.cloudformation#NotificationARN": { "type": "string" }, "com.amazonaws.cloudformation#NotificationARNs": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#NotificationARN" }, "traits": { "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.cloudformation#NumberOfResources": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#OnFailure": { "type": "enum", "members": { "DO_NOTHING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DO_NOTHING" } }, "ROLLBACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK" } }, "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } } } }, "com.amazonaws.cloudformation#OnStackFailure": { "type": "enum", "members": { "DO_NOTHING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DO_NOTHING" } }, "ROLLBACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK" } }, "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } } } }, "com.amazonaws.cloudformation#OperationEntry": { "type": "structure", "members": { "OperationType": { "target": "com.amazonaws.cloudformation#OperationType", "traits": { "smithy.api#documentation": "The type of operation.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#OperationId", "traits": { "smithy.api#documentation": "The unique identifier for the operation.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a CloudFormation operation.
" } }, "com.amazonaws.cloudformation#OperationEvent": { "type": "structure", "members": { "EventId": { "target": "com.amazonaws.cloudformation#EventId", "traits": { "smithy.api#documentation": "A unique identifier for this event.
" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "The unique ID name of the instance of the stack.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#OperationId", "traits": { "smithy.api#documentation": "The unique identifier of the operation this event belongs to.
" } }, "OperationType": { "target": "com.amazonaws.cloudformation#OperationType", "traits": { "smithy.api#documentation": "The type of operation.
" } }, "OperationStatus": { "target": "com.amazonaws.cloudformation#BeaconStackOperationStatus", "traits": { "smithy.api#documentation": "The current status of the operation.
" } }, "EventType": { "target": "com.amazonaws.cloudformation#EventType", "traits": { "smithy.api#documentation": "The type of event.
" } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#documentation": "The logical name of the resource as specified in the template.
" } }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a\n resource.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#documentation": "Type of resource.
" } }, "Timestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "Time the status was updated.
" } }, "StartTime": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The time when the event started.
" } }, "EndTime": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The time when the event ended.
" } }, "ResourceStatus": { "target": "com.amazonaws.cloudformation#ResourceStatus", "traits": { "smithy.api#documentation": "Current status of the resource.
" } }, "ResourceStatusReason": { "target": "com.amazonaws.cloudformation#ResourceStatusReason", "traits": { "smithy.api#documentation": "Success or failure message associated with the resource.
" } }, "ResourceProperties": { "target": "com.amazonaws.cloudformation#ResourceProperties", "traits": { "smithy.api#documentation": "The properties used to create the resource.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "A unique identifier for the request that initiated this operation.
" } }, "HookType": { "target": "com.amazonaws.cloudformation#HookType", "traits": { "smithy.api#documentation": "The type name of the Hook that was invoked.
" } }, "HookStatus": { "target": "com.amazonaws.cloudformation#HookStatus", "traits": { "smithy.api#documentation": "The status of the Hook invocation.
" } }, "HookStatusReason": { "target": "com.amazonaws.cloudformation#HookStatusReason", "traits": { "smithy.api#documentation": "Additional information about the Hook status.
" } }, "HookInvocationPoint": { "target": "com.amazonaws.cloudformation#HookInvocationPoint", "traits": { "smithy.api#documentation": "The point in the operation lifecycle when the Hook was invoked.
" } }, "HookFailureMode": { "target": "com.amazonaws.cloudformation#HookFailureMode", "traits": { "smithy.api#documentation": "Specifies how Hook failures are handled.
" } }, "DetailedStatus": { "target": "com.amazonaws.cloudformation#DetailedStatus", "traits": { "smithy.api#documentation": "Additional status information about the operation.
" } }, "ValidationFailureMode": { "target": "com.amazonaws.cloudformation#HookFailureMode", "traits": { "smithy.api#documentation": "Specifies how validation failures are handled.
" } }, "ValidationName": { "target": "com.amazonaws.cloudformation#ValidationName", "traits": { "smithy.api#documentation": "The name of the validation that was performed.
" } }, "ValidationStatus": { "target": "com.amazonaws.cloudformation#ValidationStatus", "traits": { "smithy.api#documentation": "The status of the validation.
" } }, "ValidationStatusReason": { "target": "com.amazonaws.cloudformation#ValidationStatusReason", "traits": { "smithy.api#documentation": "Additional information about the validation status.
" } }, "ValidationPath": { "target": "com.amazonaws.cloudformation#ValidationPath", "traits": { "smithy.api#documentation": "The path within the resource where the validation was applied.
" } } }, "traits": { "smithy.api#documentation": "Contains detailed information about an event that occurred during a CloudFormation\n operation.
" } }, "com.amazonaws.cloudformation#OperationEvents": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#OperationEvent" } }, "com.amazonaws.cloudformation#OperationId": { "type": "string" }, "com.amazonaws.cloudformation#OperationIdAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "OperationIdAlreadyExistsException", "httpResponseCode": 409 }, "smithy.api#documentation": "The specified operation ID already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudformation#OperationInProgressException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "OperationInProgressException", "httpResponseCode": 409 }, "smithy.api#documentation": "Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack\n set at a given time.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudformation#OperationNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "OperationNotFoundException", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified ID refers to an operation that doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudformation#OperationResultFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudformation#OperationResultFilterName", "traits": { "smithy.api#documentation": "The type of filter to apply.
" } }, "Values": { "target": "com.amazonaws.cloudformation#OperationResultFilterValues", "traits": { "smithy.api#documentation": "The value to filter by.
" } } }, "traits": { "smithy.api#documentation": "The status that operation results are filtered by.
" } }, "com.amazonaws.cloudformation#OperationResultFilterName": { "type": "enum", "members": { "OPERATION_RESULT_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPERATION_RESULT_STATUS" } } } }, "com.amazonaws.cloudformation#OperationResultFilterValues": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 9 }, "smithy.api#pattern": "^\\S{6,9}$" } }, "com.amazonaws.cloudformation#OperationResultFilters": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#OperationResultFilter" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.cloudformation#OperationStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.cloudformation#OperationStatusCheckFailedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ConditionalCheckFailed", "httpResponseCode": 400 }, "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI. CloudFormation doesn't\n return this error to users.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#OperationType": { "type": "enum", "members": { "CREATE_STACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_STACK" } }, "UPDATE_STACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_STACK" } }, "DELETE_STACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_STACK" } }, "CONTINUE_ROLLBACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTINUE_ROLLBACK" } }, "ROLLBACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK" } }, "CREATE_CHANGESET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_CHANGESET" } } } }, "com.amazonaws.cloudformation#OptionalSecureUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 } } }, "com.amazonaws.cloudformation#OrganizationStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "DISABLED_PERMANENTLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED_PERMANENTLY" } } } }, "com.amazonaws.cloudformation#OrganizationalUnitId": { "type": "string", "traits": { "smithy.api#pattern": "^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$" } }, "com.amazonaws.cloudformation#OrganizationalUnitIdList": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#OrganizationalUnitId" } }, "com.amazonaws.cloudformation#Output": { "type": "structure", "members": { "OutputKey": { "target": "com.amazonaws.cloudformation#OutputKey", "traits": { "smithy.api#documentation": "The key associated with the output.
" } }, "OutputValue": { "target": "com.amazonaws.cloudformation#OutputValue", "traits": { "smithy.api#documentation": "The value associated with the output.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "User defined description associated with the output.
" } }, "ExportName": { "target": "com.amazonaws.cloudformation#ExportName", "traits": { "smithy.api#documentation": "The name of the export associated with the output.
" } } }, "traits": { "smithy.api#documentation": "The Output data type.
The key associated with the parameter. If you don't specify a key and value for a particular\n parameter, CloudFormation uses the default value that's specified in your template.
" } }, "ParameterValue": { "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { "smithy.api#documentation": "The input value associated with the parameter.
" } }, "UsePreviousValue": { "target": "com.amazonaws.cloudformation#UsePreviousValue", "traits": { "smithy.api#documentation": "During a stack update, use the existing parameter value that the stack is using for a given\n parameter key. If you specify true, do not specify a parameter value.
Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only\n for Systems Manager parameter types in the template. For more information, see Specify\n existing resources at runtime with CloudFormation-supplied parameter types in the\n CloudFormation User Guide.
" } } }, "traits": { "smithy.api#documentation": "The Parameter data type.
A list of values that are permitted for a parameter.
" } } }, "traits": { "smithy.api#documentation": "A set of criteria that CloudFormation uses to validate parameter values. Although other\n constraints might be defined in the stack template, CloudFormation returns only the\n AllowedValues property.
The name that's associated with the parameter.
" } }, "DefaultValue": { "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { "smithy.api#documentation": "The default value of the parameter.
" } }, "ParameterType": { "target": "com.amazonaws.cloudformation#ParameterType", "traits": { "smithy.api#documentation": "The type of parameter.
" } }, "NoEcho": { "target": "com.amazonaws.cloudformation#NoEcho", "traits": { "smithy.api#documentation": "Flag that indicates whether the parameter value is shown as plain text in logs and in the\n Amazon Web Services Management Console.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "The description that's associate with the parameter.
" } }, "ParameterConstraints": { "target": "com.amazonaws.cloudformation#ParameterConstraints", "traits": { "smithy.api#documentation": "The criteria that CloudFormation uses to validate parameter values.
" } } }, "traits": { "smithy.api#documentation": "The ParameterDeclaration data type.
The resource context key.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.cloudformation#Value", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The resource context value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough to\n uniquely identify that resource. Each context key-value pair specifies a resource that contains\n the targeted resource.
" } }, "com.amazonaws.cloudformation#PolicyAction": { "type": "enum", "members": { "Delete": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Delete" } }, "Retain": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Retain" } }, "Snapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Snapshot" } }, "ReplaceAndDelete": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReplaceAndDelete" } }, "ReplaceAndRetain": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReplaceAndRetain" } }, "ReplaceAndSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReplaceAndSnapshot" } } } }, "com.amazonaws.cloudformation#PreviousDeploymentContext": { "type": "string" }, "com.amazonaws.cloudformation#PrivateTypeArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+$" } }, "com.amazonaws.cloudformation#Properties": { "type": "string" }, "com.amazonaws.cloudformation#PropertyDescription": { "type": "string" }, "com.amazonaws.cloudformation#PropertyDifference": { "type": "structure", "members": { "PropertyPath": { "target": "com.amazonaws.cloudformation#PropertyPath", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The fully-qualified path to the resource property.
", "smithy.api#required": {} } }, "ExpectedValue": { "target": "com.amazonaws.cloudformation#PropertyValue", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The expected property value of the resource property, as defined in the stack template and\n any values specified as template parameters.
", "smithy.api#required": {} } }, "ActualValue": { "target": "com.amazonaws.cloudformation#PropertyValue", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The actual property value of the resource property.
", "smithy.api#required": {} } }, "DifferenceType": { "target": "com.amazonaws.cloudformation#DifferenceType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of property difference.
\n\n ADD: A value has been added to a resource property that's an array or list\n data type.
\n REMOVE: The property has been removed from the current resource\n configuration.
\n NOT_EQUAL: The current property value differs from its expected value (as\n defined in the stack template and any values specified as template parameters).
Information about a resource property whose actual value differs from its expected value, as\n defined in the stack template and any values specified as template parameters. These will be\n present only for resources whose StackResourceDriftStatus is MODIFIED.\n For more information, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.
Publishes the specified extension to the CloudFormation registry as a public extension in this\n Region. Public extensions are available for use by all CloudFormation users. For more information\n about publishing extensions, see Publishing extensions to\n make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more\n information, see RegisterPublisher.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudformation#PublishTypeInput": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { "smithy.api#documentation": "The type of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The name of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version\n number to your extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning\n 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one\n minor version release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation\n automatically sets the first version number to be 1.0.0.
The Amazon Resource Name (ARN) assigned to the public extension upon publication.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#PublisherId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40 }, "smithy.api#pattern": "^[0-9a-zA-Z]{12,40}$" } }, "com.amazonaws.cloudformation#PublisherName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.cloudformation#PublisherProfile": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^(http:|https:)+[^\\s]+[\\w]$" } }, "com.amazonaws.cloudformation#PublisherStatus": { "type": "enum", "members": { "VERIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VERIFIED" } }, "UNVERIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNVERIFIED" } } } }, "com.amazonaws.cloudformation#Reason": { "type": "string" }, "com.amazonaws.cloudformation#RecordHandlerProgress": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#RecordHandlerProgressInput" }, "output": { "target": "com.amazonaws.cloudformation#RecordHandlerProgressOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#InvalidStateTransitionException" }, { "target": "com.amazonaws.cloudformation#OperationStatusCheckFailedException" } ], "traits": { "smithy.api#documentation": "Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation\n CLI. Don't use this API in your code.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudformation#RecordHandlerProgressInput": { "type": "structure", "members": { "BearerToken": { "target": "com.amazonaws.cloudformation#ClientToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", "smithy.api#required": {} } }, "OperationStatus": { "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", "smithy.api#required": {} } }, "CurrentOperationStatus": { "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "StatusMessage": { "target": "com.amazonaws.cloudformation#StatusMessage", "traits": { "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "ErrorCode": { "target": "com.amazonaws.cloudformation#HandlerErrorCode", "traits": { "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "ResourceModel": { "target": "com.amazonaws.cloudformation#ResourceModel", "traits": { "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#RecordHandlerProgressOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#RefreshAllResources": { "type": "boolean" }, "com.amazonaws.cloudformation#Region": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9-]{1,128}$" } }, "com.amazonaws.cloudformation#RegionConcurrencyType": { "type": "enum", "members": { "SEQUENTIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEQUENTIAL" } }, "PARALLEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARALLEL" } } } }, "com.amazonaws.cloudformation#RegionList": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#Region" } }, "com.amazonaws.cloudformation#RegionalStackInstancesDeployment": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.cloudformation#StageStatus", "traits": { "smithy.api#documentation": "The status of the stack instances deployment stage can be one of the following values:
\n\n NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation.
\n NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached.
\n IN_PROGRESS: At least one stack instance has started deploying.
\n SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped.
\n PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances.
\n FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.
The number of stack instances that deployed successfully in this Region.
" } }, "FailedStackInstancesCount": { "target": "com.amazonaws.cloudformation#StackInstancesDeploymentFailedStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances that failed to deploy in this Region.
" } }, "CompletedStackInstancesCount": { "target": "com.amazonaws.cloudformation#CompletedStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances in this Region that have reached a final state. This count includes stack instances that succeeded, failed, were skipped, or were canceled.
" } }, "PendingStackInstancesCount": { "target": "com.amazonaws.cloudformation#PendingStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances in this Region that have not reached a final state. This is the total number of stack instances in this Region minus the completed count.
" } }, "CancelledStackInstancesCount": { "target": "com.amazonaws.cloudformation#CancelledStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances in this Region that were canceled because the operation exceeded its failure tolerance or was stopped.
" } }, "SkippedStackInstancesCount": { "target": "com.amazonaws.cloudformation#SkippedStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances in this Region that were skipped because role provisioning failed for their target account.
" } }, "TotalStackInstancesCount": { "target": "com.amazonaws.cloudformation#RegionalTotalStackInstancesCount", "traits": { "smithy.api#documentation": "The total number of stack instances targeted by this operation in this Region.
" } }, "PercentageCompleted": { "target": "com.amazonaws.cloudformation#StagePercentageCompleted", "traits": { "smithy.api#documentation": "The percentage of stack instances in this Region that have reached a final state.
" } } }, "traits": { "smithy.api#documentation": "Provides visibility into the stack instances deployment stage for a single Region, including per-stack-instance progress counts and a completion percentage for that Region.
" } }, "com.amazonaws.cloudformation#RegionalStages": { "type": "structure", "members": { "RegionalStackInstancesDeployment": { "target": "com.amazonaws.cloudformation#RegionalStackInstancesDeployment", "traits": { "smithy.api#documentation": "The progress detail for the stack instances deployment stage in this Region.
" } } }, "traits": { "smithy.api#documentation": "Contains the progress information for the individual stages of a StackSet operation in a single Region. Currently reports the stack instances deployment stage for the Region.
" } }, "com.amazonaws.cloudformation#RegionalStatusDetail": { "type": "structure", "members": { "Stages": { "target": "com.amazonaws.cloudformation#RegionalStages", "traits": { "smithy.api#documentation": "The progress information for the individual stages of the operation in this Region.
" } } }, "traits": { "smithy.api#documentation": "Contains the progress detail for a single Region of a StackSet operation. This information is returned only by DescribeStackSetOperation.
" } }, "com.amazonaws.cloudformation#RegionalStatusDetails": { "type": "map", "key": { "target": "com.amazonaws.cloudformation#Region" }, "value": { "target": "com.amazonaws.cloudformation#RegionalStatusDetail" } }, "com.amazonaws.cloudformation#RegionalTotalStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#RegisterPublisher": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#RegisterPublisherInput" }, "output": { "target": "com.amazonaws.cloudformation#RegisterPublisherOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CFNRegistryException" } ], "traits": { "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry.\n Public extensions are available for use by all CloudFormation users. This publisher ID applies to\n your account in all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see\n Prerequisite: Registering your account to publish CloudFormation extensions in the\n CloudFormation Command Line Interface (CLI) User Guide.
\n ", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudformation#RegisterPublisherInput": { "type": "structure", "members": { "AcceptTermsAndConditions": { "target": "com.amazonaws.cloudformation#AcceptTermsAndConditions", "traits": { "smithy.api#documentation": "Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must\n accept the terms and conditions in order to register to publish public extensions to the\n CloudFormation registry.
\nThe default is false.
If you are using a Bitbucket or GitHub account for identity verification, the Amazon\n Resource Name (ARN) for your connection to that account.
\nFor more information, see Prerequisite: Registering your account to publish CloudFormation extensions in the\n CloudFormation Command Line Interface (CLI) User Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#RegisterPublisherOutput": { "type": "structure", "members": { "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { "smithy.api#documentation": "The ID assigned this account by CloudFormation for publishing extensions.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#RegisterType": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#RegisterTypeInput" }, "output": { "target": "com.amazonaws.cloudformation#RegisterTypeOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CFNRegistryException" } ], "traits": { "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it\n available for use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration, see\n Creating resource types using the CloudFormation CLI in the\n CloudFormation Command Line Interface (CLI) User Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This\n maximum is per account and per Region. Use DeregisterType\n to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using RegisterType, you\n can use DescribeTypeRegistration to monitor the progress of the registration\n request.
\nOnce you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudformation#RegisterTypeInput": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { "smithy.api#documentation": "The kind of extension.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types, company_or_organization::service::type.
For modules, company_or_organization::service::type::MODULE.
For Hooks, MyCompany::Testing::MyTestHook.
The following organization namespaces are reserved and can't be used in your extension\n names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
A URL to the S3 bucket that contains the extension project package that contains the\n necessary files for the extension you want to register.
\nFor information about generating a schema handler package for the extension you want to\n register, see submit in\n the CloudFormation Command Line Interface (CLI) User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket.\n That's, the user needs to have GetObject permissions for the schema\n handler package. For more information, see Actions, Resources, and Condition Keys for\n Amazon S3 in the Identity and Access Management User Guide.
\nSpecifies logging configuration information for an extension.
" } }, "ExecutionRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking\n the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain a trust\n relationship with the CloudFormation service principal\n (resources.cloudformation.amazonaws.com). For more information about adding\n trust relationships, see Modifying a role trust policy in the Identity and Access Management User\n Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an\n \n IAM\n execution role\n that includes the necessary permissions to call those\n Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke\n the resource type handler, CloudFormation assumes this execution role to create a temporary\n session token, which it then passes to the resource type handler, thereby supplying your\n resource type with the appropriate credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#RequestToken", "traits": { "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request.\n Specifying a client request token prevents CloudFormation from generating more than one version of\n an extension from the same registration request, even if the request is submitted multiple\n times.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#RegisterTypeOutput": { "type": "structure", "members": { "RegistrationToken": { "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { "smithy.api#documentation": "The identifier for this registration request.
\nUse this registration token when calling DescribeTypeRegistration, which\n returns information about the status and IDs of the extension registration.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#RegistrationStatus": { "type": "enum", "members": { "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.cloudformation#RegistrationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9][-a-zA-Z0-9]*$" } }, "com.amazonaws.cloudformation#RegistrationTokenList": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#RegistrationToken" } }, "com.amazonaws.cloudformation#RegistryType": { "type": "enum", "members": { "RESOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE" } }, "MODULE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MODULE" } }, "HOOK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOOK" } } } }, "com.amazonaws.cloudformation#RelatedResources": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ScannedResource" } }, "com.amazonaws.cloudformation#RemediationMessageRemediationMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16384 } } }, "com.amazonaws.cloudformation#RemediationMessageStatusMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16384 } } }, "com.amazonaws.cloudformation#RemoveAlias": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#RemoveAliasInput" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Removes an alias from a stack. After the alias is removed successfully, it can no longer be used to\n reference the stack in API calls.
", "smithy.api#examples": [ { "title": "Example \u2013 Remove an alias from a stack", "documentation": "The following example removes the alias MyAlias from your stack:", "input": { "AliasName": "MyAlias" } } ] } }, "com.amazonaws.cloudformation#RemoveAliasInput": { "type": "structure", "members": { "AliasName": { "target": "com.amazonaws.cloudformation#AliasName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The alias name to remove.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The input for the RemoveAlias action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#Replacement": { "type": "enum", "members": { "True": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "True" } }, "False": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "False" } }, "Conditional": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Conditional" } } } }, "com.amazonaws.cloudformation#RequestToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9][-a-zA-Z0-9]*$" } }, "com.amazonaws.cloudformation#RequiredActivatedType": { "type": "structure", "members": { "TypeNameAlias": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "An alias assigned to the public extension, in this account and Region. If you specify an\n alias for the extension, CloudFormation treats the alias as the extension type name within this\n account and Region. You must use the alias to refer to the extension in your templates, API\n calls, and CloudFormation console.
" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "The type name of the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the account and\n Region, not the type name of the public extension. For more information, see Use\n aliases to refer to extensions in the CloudFormation User Guide.
The publisher ID of the extension publisher.
" } }, "SupportedMajorVersions": { "target": "com.amazonaws.cloudformation#SupportedMajorVersions", "traits": { "smithy.api#documentation": "A list of the major versions of the extension type that the macro supports.
" } } }, "traits": { "smithy.api#documentation": "For extensions that are modules, a public third-party extension that must be activated in\n your account in order for the module itself to be activated.
\nFor more information, see Requirements for activating third-party public modules in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#RequiredActivatedTypes": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#RequiredActivatedType" } }, "com.amazonaws.cloudformation#RequiredProperty": { "type": "boolean" }, "com.amazonaws.cloudformation#RequiresRecreation": { "type": "enum", "members": { "Never": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Never" } }, "Conditionally": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Conditionally" } }, "Always": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Always" } } } }, "com.amazonaws.cloudformation#ResourceAttribute": { "type": "enum", "members": { "Properties": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Properties" } }, "Metadata": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Metadata" } }, "CreationPolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreationPolicy" } }, "UpdatePolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdatePolicy" } }, "DeletionPolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeletionPolicy" } }, "UpdateReplacePolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateReplacePolicy" } }, "Tags": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Tags" } } } }, "com.amazonaws.cloudformation#ResourceChange": { "type": "structure", "members": { "PolicyAction": { "target": "com.amazonaws.cloudformation#PolicyAction", "traits": { "smithy.api#documentation": "The action that will be taken on the physical resource when the change set is\n executed.
\n\n Delete The resource will be deleted.
\n Retain The resource will be retained.
\n Snapshot The resource will have a snapshot taken.
\n ReplaceAndDelete The resource will be replaced and then deleted.
\n ReplaceAndRetain The resource will be replaced and then retained.
\n ReplaceAndSnapshot The resource will be replaced and then have a snapshot\n taken.
The action that CloudFormation takes on the resource, such as Add (adds a new\n resource), Modify (changes a resource), Remove (deletes a resource),\n Import (imports a resource), Dynamic (exact action for the resource\n can't be determined), or SyncWithActual (resource will not be changed, only\n CloudFormation metadata will change).
The resource's logical ID, which is defined in the stack's template.
" } }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "The resource's physical ID (resource name). Resources that you are adding don't have\n physical IDs because they haven't been created.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#documentation": "The type of CloudFormation resource, such as AWS::S3::Bucket.
For the Modify action, indicates whether CloudFormation will replace the resource\n by creating a new one and deleting the old one. This value depends on the value of the\n RequiresRecreation property in the ResourceTargetDefinition structure.\n For example, if the RequiresRecreation field is Always and the\n Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is\n Conditional.
If you have multiple changes with different RequiresRecreation values, the\n Replacement value depends on the change with the most impact. A\n RequiresRecreation value of Always has the most impact, followed by\n Conditional, and then Never.
For the Modify action, indicates which resource attribute is triggering this\n update, such as a change in the resource attribute's Metadata,\n Properties, or Tags.
The drift status of the resource. Valid values:
\n\n IN_SYNC \u2013 The resource matches its template definition.
\n MODIFIED \u2013 Resource properties were modified outside CloudFormation.
\n DELETED \u2013 The resource was deleted outside CloudFormation.
\n NOT_CHECKED \u2013 CloudFormation doesn\u2019t currently return this value.
\n UNKNOWN \u2013 Drift status could not be determined.
\n UNSUPPORTED \u2013 Resource type does not support actual state comparison.
Only present for drift-aware change sets.
" } }, "ResourceDriftIgnoredAttributes": { "target": "com.amazonaws.cloudformation#ResourceDriftIgnoredAttributes", "traits": { "smithy.api#documentation": "List of resource attributes for which drift was ignored.
" } }, "Details": { "target": "com.amazonaws.cloudformation#ResourceChangeDetails", "traits": { "smithy.api#documentation": "For the Modify action, a list of ResourceChangeDetail structures\n that describes the changes that CloudFormation will make to the resource.
The change set ID of the nested change set.
" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } }, "BeforeContext": { "target": "com.amazonaws.cloudformation#BeforeContext", "traits": { "smithy.api#documentation": "An encoded JSON string that contains the context of the resource before the change is\n executed.
" } }, "AfterContext": { "target": "com.amazonaws.cloudformation#AfterContext", "traits": { "smithy.api#documentation": "An encoded JSON string that contains the context of the resource after the change is\n executed.
" } }, "PreviousDeploymentContext": { "target": "com.amazonaws.cloudformation#PreviousDeploymentContext", "traits": { "smithy.api#documentation": "Information about the resource's state from the previous CloudFormation deployment.
" } } }, "traits": { "smithy.api#documentation": "The ResourceChange structure describes the resource and the action that\n CloudFormation will perform on it if you execute this change set.
A ResourceTargetDefinition structure that describes the field that CloudFormation\n will change and whether the resource will be recreated.
Indicates whether CloudFormation can determine the target value, and whether the target value\n will change before you execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target value will\n change, and its value. For example, if you directly modify the InstanceType property\n of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this\n is a Static evaluation.
For Dynamic evaluations, can't determine the target value because it depends on\n the result of an intrinsic function, such as a Ref or Fn::GetAtt\n intrinsic function, when the stack is updated. For example, if your template includes a reference\n to a resource that's conditionally recreated, the value of the reference (the physical ID of the\n resource) might change, depending on if the resource is recreated. If the resource is recreated,\n it will have a new physical ID, so all references to that resource will also be updated.
The group to which the CausingEntity value belongs. There are five entity\n groups:
\n ResourceReference entities are Ref intrinsic functions that refer to\n resources in the template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.
\n ParameterReference entities are Ref intrinsic functions that get\n template parameter values, such as { \"Ref\" : \"MyPasswordParameter\" }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic functions that\n get resource attribute values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\",\n \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the\n template.
\n Automatic entities are AWS::CloudFormation::Stack resource types,\n which are also known as nested stacks. If you made no changes to the\n AWS::CloudFormation::Stack resource, CloudFormation sets the\n ChangeSource to Automatic because the nested stack's template might\n have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run\n an update on the parent stack.
\n NoModification entities are changes made to the template that matches the actual\n state of the resource.
The identity of the entity that triggered this change. This entity is a member of the group\n that's specified by the ChangeSource field. For example, if you modified the value\n of the KeyPairName parameter, the CausingEntity is the name of the\n parameter (KeyPairName).
If the ChangeSource value is DirectModification, no value is given\n for CausingEntity.
For a resource with Modify as the action, the ResourceChange\n structure describes the changes CloudFormation will make to that resource.
The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection in the\n CloudFormation User Guide\n
The logical resource id for this resource in the generated template.
" } }, "ResourceIdentifier": { "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of up to 256 key-value pairs that identifies the scanned resource. The key is the\n name of one of the primary identifiers for the resource. (Primary identifiers are specified in\n the primaryIdentifier list in the resource schema.) The value is the value of that\n primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary\n identifiers is TableName so the key-value pair could be \"TableName\":\n \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
A resource included in a generated template. This data type is used with the\n CreateGeneratedTemplate and UpdateGeneratedTemplate API\n actions.
The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection In the\n CloudFormation User Guide\n
The logical id for this resource in the final generated template.
" } }, "ResourceIdentifier": { "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", "traits": { "smithy.api#documentation": "A list of up to 256 key-value pairs that identifies the resource in the generated template.\n The key is the name of one of the primary identifiers for the resource. (Primary identifiers are\n specified in the primaryIdentifier list in the resource schema.) The value is the\n value of that primary identifier. For example, for a AWS::DynamoDB::Table resource,\n the primary identifiers is TableName so the key-value pair could be\n \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
Status of the processing of a resource in a generated template.
\nThe resource processing is still in progress.
\nThe resource processing is complete.
\nThe resource processing is pending.
\nThe resource processing has failed.
\nThe reason for the resource detail, providing more information if a failure happened.
" } }, "Warnings": { "target": "com.amazonaws.cloudformation#WarningDetails", "traits": { "smithy.api#documentation": "The warnings generated for this resource.
" } } }, "traits": { "smithy.api#documentation": "Details about a resource in a generated template
" } }, "com.amazonaws.cloudformation#ResourceDetails": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ResourceDetail" }, "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.cloudformation#ResourceDriftActualValue": { "type": "string" }, "com.amazonaws.cloudformation#ResourceDriftIgnoredAttribute": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.cloudformation#ResourcePropertyPath", "traits": { "smithy.api#documentation": "Path of the resource attribute for which drift was ignored.
" } }, "Reason": { "target": "com.amazonaws.cloudformation#DriftIgnoredReason", "traits": { "smithy.api#documentation": "Reason why drift was ignored for the attribute, can have 3 possible values:
\n\n WRITE_ONLY_PROPERTY \u2013 Property is not included in read response for the\n resource\u2019s live state.
\n MANAGED_BY_AWS \u2013 Property is managed by an Amazon Web Services service and is expected to be\n dynamically modified.
\n SENSITIVE_PROPERTY \u2013 Property has a sensitive value, such as an Amazon Web Services Secrets Manager value.
The ResourceDriftIgnoredAttribute data type.
The template resource type of the target resources, such as\n AWS::S3::Bucket.
The logical IDs of the target resources of the specified ResourceType, as\n defined in the import template.
The resource properties you can provide during the import to identify your target\n resources. For example, BucketName is a possible identifier property for\n AWS::S3::Bucket resources.
Describes the target resources of a specific type in your import template (for example,\n all AWS::S3::Bucket resources) and the properties you can provide during the\n import to identify resources of that type.
The name associated with the stack.
", "smithy.api#required": {} } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The logical name of the resource specified in the template.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The location of the resource in a stack template.
" } }, "com.amazonaws.cloudformation#ResourceMapping": { "type": "structure", "members": { "Source": { "target": "com.amazonaws.cloudformation#ResourceLocation", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The source stack StackName and LogicalResourceId for the resource\n being refactored.
The destination stack StackName and LogicalResourceId for the\n resource being refactored.
Specifies the current source of the resource and the destination of where it will be moved\n to.
" } }, "com.amazonaws.cloudformation#ResourceMappings": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ResourceMapping" } }, "com.amazonaws.cloudformation#ResourceModel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16384 } } }, "com.amazonaws.cloudformation#ResourceProperties": { "type": "string" }, "com.amazonaws.cloudformation#ResourcePropertyPath": { "type": "string" }, "com.amazonaws.cloudformation#ResourceScanId": { "type": "string" }, "com.amazonaws.cloudformation#ResourceScanInProgressException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceScanInProgress", "httpResponseCode": 400 }, "smithy.api#documentation": "A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#ResourceScanLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceScanLimitExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The limit on resource scans has been exceeded. Reasons include:
\nExceeded the daily quota for resource scans.
\nA resource scan recently failed. You must wait 10 minutes before starting a new resource scan.
\nThe last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours\n before starting a new resource scan.
\nThe resource scan was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#ResourceScanStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } } } }, "com.amazonaws.cloudformation#ResourceScanStatusReason": { "type": "string" }, "com.amazonaws.cloudformation#ResourceScanSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ResourceScanSummary" } }, "com.amazonaws.cloudformation#ResourceScanSummary": { "type": "structure", "members": { "ResourceScanId": { "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource scan.
" } }, "Status": { "target": "com.amazonaws.cloudformation#ResourceScanStatus", "traits": { "smithy.api#documentation": "Status of the resource scan.
\nThe resource scan is still in progress.
\nThe resource scan is complete.
\nThe resource scan has expired.
\nThe resource scan has failed.
\nThe reason for the resource scan status, providing more information if a failure\n happened.
" } }, "StartTime": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The time that the resource scan was started.
" } }, "EndTime": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The time that the resource scan was finished.
" } }, "PercentageCompleted": { "target": "com.amazonaws.cloudformation#PercentageCompleted", "traits": { "smithy.api#documentation": "The percentage of the resource scan that has been completed.
" } }, "ScanType": { "target": "com.amazonaws.cloudformation#ScanType", "traits": { "smithy.api#documentation": "The scan type that has been completed.
" } } }, "traits": { "smithy.api#documentation": "A summary of the resource scan. This is returned by the ListResourceScan API\n action.
Indicates which resource attribute is triggering this update, such as a change in the\n resource attribute's Metadata, Properties, or Tags.
If the Attribute value is Properties, the name of the property.\n For all other attributes, the value is null.
If the Attribute value is Properties, indicates whether a change\n to this property causes the resource to be recreated. The value can be Never,\n Always, or Conditionally. To determine the conditions for a\n Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.
The property path of the property.
" } }, "BeforeValue": { "target": "com.amazonaws.cloudformation#BeforeValue", "traits": { "smithy.api#documentation": "The value of the property before the change is executed. Large values can be\n truncated.
" } }, "AfterValue": { "target": "com.amazonaws.cloudformation#AfterValue", "traits": { "smithy.api#documentation": "The value of the property after the change is executed. Large values can be\n truncated.
" } }, "BeforeValueFrom": { "target": "com.amazonaws.cloudformation#BeforeValueFrom", "traits": { "smithy.api#documentation": "Indicates the source of the before value. Valid values:
\n\n ACTUAL_STATE \u2013 The before value represents current actual state.
\n PREVIOUS_DEPLOYMENT_STATE \u2013 The before value represents the previous\n CloudFormation deployment state.
Only present for drift-aware change sets.
" } }, "AfterValueFrom": { "target": "com.amazonaws.cloudformation#AfterValueFrom", "traits": { "smithy.api#documentation": "Indicates the source of the after value. Valid value:
\n\n TEMPLATE \u2013 The after value comes from the new template.
Only present for drift-aware change sets.
" } }, "Drift": { "target": "com.amazonaws.cloudformation#LiveResourceDrift", "traits": { "smithy.api#documentation": "Detailed drift information for the resource property, including actual values, previous\n deployment values, and drift detection timestamps.
" } }, "AttributeChangeType": { "target": "com.amazonaws.cloudformation#AttributeChangeType", "traits": { "smithy.api#documentation": "The type of change to be made to the property if the change is executed.
\n\n Add The item will be added.
\n Remove The item will be removed.
\n Modify The item will be modified.
\n SyncWithActual The drift status of this item will be reset but the item will\n not be modified.
The field that CloudFormation will change, such as the name of a resource's property, and\n whether the resource will be recreated.
" } }, "com.amazonaws.cloudformation#ResourceToImport": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of resource to import into your stack, such as AWS::S3::Bucket. For a\n list of supported resource types, see Resource type\n support for imports and drift detection in the\n CloudFormation User Guide.
The logical ID of the target resource as specified in the template.
", "smithy.api#required": {} } }, "ResourceIdentifier": { "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A key-value pair that identifies the target resource. The key is an identifier property (for\n example, BucketName for AWS::S3::Bucket resources) and the value is the\n actual property value (for example, MyS3Bucket).
Describes the target resource of an import operation.
" } }, "com.amazonaws.cloudformation#ResourceToSkip": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\\.[a-zA-Z0-9]+$" } }, "com.amazonaws.cloudformation#ResourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.cloudformation#ResourceTypeFilter": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.cloudformation#ResourceTypeFilters": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ResourceTypeFilter" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.cloudformation#ResourceTypePrefix": { "type": "string" }, "com.amazonaws.cloudformation#ResourceTypes": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ResourceType" } }, "com.amazonaws.cloudformation#ResourcesFailed": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#ResourcesPending": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#ResourcesProcessing": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#ResourcesRead": { "type": "integer" }, "com.amazonaws.cloudformation#ResourcesScanned": { "type": "integer" }, "com.amazonaws.cloudformation#ResourcesSucceeded": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#ResourcesToImport": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ResourceToImport" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.cloudformation#ResourcesToSkip": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ResourceToSkip" } }, "com.amazonaws.cloudformation#RetainExceptOnCreate": { "type": "boolean" }, "com.amazonaws.cloudformation#RetainResources": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#LogicalResourceId" } }, "com.amazonaws.cloudformation#RetainStacks": { "type": "boolean" }, "com.amazonaws.cloudformation#RetainStacksNullable": { "type": "boolean" }, "com.amazonaws.cloudformation#RetainStacksOnAccountRemovalNullable": { "type": "boolean" }, "com.amazonaws.cloudformation#RoleARN": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 } } }, "com.amazonaws.cloudformation#RoleARN2": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^arn:.+:iam::[0-9]{12}:role/.+$" } }, "com.amazonaws.cloudformation#RoleProvisioning": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.cloudformation#StageStatus", "traits": { "smithy.api#documentation": "The status of the role provisioning stage can be one of the following values:
\n\n NOT_APPLICABLE: The operation does not provision roles. This includes self-managed operations and service-managed operations whose configuration does not require role provisioning.
\n NOT_STARTED: Role provisioning has not started. The operation has not begun resolving target accounts, or it failed or stopped before the total number of target accounts was resolved.
\n IN_PROGRESS: Role provisioning is actively processing target accounts.
\n SUCCEEDED: Role provisioning finished and succeeded for all target accounts.
\n PARTIAL_SUCCESS: Role provisioning finished, but succeeded for only a subset of target accounts; one or more accounts failed.
\n FAILED: Role provisioning finished and failed for all target accounts.
The number of accounts for which role provisioning succeeded.
" } }, "FailedAccountsCount": { "target": "com.amazonaws.cloudformation#FailedAccountsCount", "traits": { "smithy.api#documentation": "The number of accounts for which role provisioning failed.
" } }, "CompletedAccountsCount": { "target": "com.amazonaws.cloudformation#CompletedAccountsCount", "traits": { "smithy.api#documentation": "The number of accounts that have finished role provisioning, including both succeeded and failed accounts.
" } }, "PendingAccountsCount": { "target": "com.amazonaws.cloudformation#PendingAccountsCount", "traits": { "smithy.api#documentation": "The number of accounts that are still awaiting role provisioning.
" } }, "PercentageCompleted": { "target": "com.amazonaws.cloudformation#StagePercentageCompleted", "traits": { "smithy.api#documentation": "The percentage of accounts that have completed role provisioning.
" } } }, "traits": { "smithy.api#documentation": "Provides visibility into the role provisioning stage of a StackSet operation, including per-account progress counts and a completion percentage. For operations that do not provision IAM roles in target accounts, the Status is NOT_APPLICABLE and the progress counts are omitted.
The triggers to monitor during stack creation or update actions.
\nBy default, CloudFormation saves the rollback triggers specified for a stack and applies them to\n any subsequent update operations for the stack, unless you specify otherwise. If you do specify\n rollback triggers for this parameter, those triggers replace any list of triggers previously\n specified for the stack. This means:
\nTo use the rollback triggers previously specified for this stack, if any, don't specify\n this parameter.
\nTo specify new or updated rollback triggers, you must specify all the\n triggers that you want used for this stack, even triggers you've specified before (for example,\n when creating the stack or during a previous stack update). Any triggers that you don't include\n in the updated list of triggers are no longer applied to the stack.
\nTo remove all currently specified triggers, specify an empty list for this\n parameter.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled\n back.
" } }, "MonitoringTimeInMinutes": { "target": "com.amazonaws.cloudformation#MonitoringTimeInMinutes", "traits": { "smithy.api#documentation": "The amount of time, in minutes, during which CloudFormation should monitor all the rollback\n triggers after the stack creation or update operation deploys all necessary resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but don't specify any rollback triggers, CloudFormation still\n waits the specified period of time before cleaning up old resources after update operations. You\n can use this monitoring period to perform any manual stack validation desired, and manually\n cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
\nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback\n triggers during stack creation and update operations. Then, for update operations, it begins\n disposing of old resources immediately once the operation completes.
" } } }, "traits": { "smithy.api#documentation": "Structure that contains the rollback triggers for CloudFormation to monitor during stack\n creation and updating operations, and for the specified monitoring period afterwards.
\nRollback triggers enable you to have CloudFormation monitor the state of your application during\n stack creation and updating, and to roll back that operation if the application breaches the\n threshold of any of the alarms you've specified. For more information, see Roll back your CloudFormation stack on alarm breach with rollback triggers.
" } }, "com.amazonaws.cloudformation#RollbackStack": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#RollbackStackInput" }, "output": { "target": "com.amazonaws.cloudformation#RollbackStackOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" } ], "traits": { "smithy.api#documentation": "When specifying RollbackStack, you preserve the state of previously\n provisioned resources when an operation fails. You can check the status of the stack through\n the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from\n 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\n known stable state includes any status in a *_COMPLETE. This includes the\n following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
The name that's associated with the stack.
", "smithy.api#required": {} } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the\n stack.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "A unique identifier for this RollbackStack request.
When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
The deployment configuration for this stack operation, including the deployment\n mode.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#RollbackStackOutput": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "Unique identifier of the stack.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#OperationId", "traits": { "smithy.api#documentation": "A unique identifier for this rollback operation that can be used to track the operation's\n progress and events.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#RollbackTrigger": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.cloudformation#Arn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rollback trigger.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled\n back.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.cloudformation#Type", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the\n alarms you specify goes to ALARM state during the stack operation or within the specified\n monitoring period afterwards, CloudFormation rolls back the entire stack operation.
" } }, "com.amazonaws.cloudformation#RollbackTriggers": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#RollbackTrigger" }, "traits": { "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.cloudformation#S3Bucket": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 63 }, "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.cloudformation#S3Url": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.cloudformation#ScanFilter": { "type": "structure", "members": { "Types": { "target": "com.amazonaws.cloudformation#ResourceTypeFilters", "traits": { "smithy.api#documentation": "An array of strings where each string represents an Amazon Web Services resource type you want to scan.\n Each string defines the resource type using the format\n AWS::ServiceName::ResourceType, for example, AWS::DynamoDB::Table. For\n the full list of supported resource types, see the Resource type\n support table in the CloudFormation User Guide.
To scan all resource types within a service, you can use a wildcard, represented by an\n asterisk (*). You can place an asterisk at only the end of the string, for example,\n AWS::S3::*.
A filter that is used to specify which resource types to scan.
" } }, "com.amazonaws.cloudformation#ScanFilters": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ScanFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.cloudformation#ScanType": { "type": "enum", "members": { "FULL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FULL" } }, "PARTIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL" } } } }, "com.amazonaws.cloudformation#ScannedResource": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#documentation": "The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection In the\n CloudFormation User Guide\n
A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the\n name of one of the primary identifiers for the resource. (Primary identifiers are specified in\n the primaryIdentifier list in the resource schema.) The value is the value of that\n primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary\n identifiers is TableName so the key-value pair could be \"TableName\":\n \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
If true, the resource is managed by a CloudFormation stack.
A scanned resource returned by ListResourceScanResources or\n ListResourceScanRelatedResources.
The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection In the\n CloudFormation User Guide.
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the\n name of one of the primary identifiers for the resource. (Primary identifiers are specified in\n the primaryIdentifier list in the resource schema.) The value is the value of that\n primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary\n identifiers is TableName so the key-value pair could be \"TableName\":\n \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
Identifies a scanned resource. This is used with the\n ListResourceScanRelatedResources API action.
Assigns an alias to an existing stack. An alias is an alternative name for a stack that\n can be used in place of the stack name in any CloudFormation API call that accepts the\n StackName parameter. This enables you to effectively rename a stack without\n recreating it.
After setting an alias, both the original stack name and the alias resolve to the same\n stack. Setting an alias does not change the stack's ARN, physical resource IDs, or any\n deployed resources.
\nEach stack can have at most one alias. To change a stack's alias, first remove the\n existing alias using RemoveAlias, then set a new one.
\nThe name or unique stack ID of the stack to assign an alias to.
", "smithy.api#required": {} } }, "AliasName": { "target": "com.amazonaws.cloudformation#AliasName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The alias to assign to the stack. The alias can then be used in place of the stack name in\n any API call that accepts StackName.
The name must be unique within the same account and Region. It cannot match an\n existing stack name or another active alias.
\nAn alias name can contain only alphanumeric characters (case-sensitive) and hyphens. It\n must start with an alphabetic character and can't be longer than 128 characters.
\nThe input for the SetAlias action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#SetStackPolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#SetStackPolicyInput" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Sets a stack policy for a specified stack.
" } }, "com.amazonaws.cloudformation#SetStackPolicyInput": { "type": "structure", "members": { "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or unique stack ID that you want to associate a policy with.
", "smithy.api#required": {} } }, "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { "smithy.api#documentation": "Structure that contains the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Location of a file that contains the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for\n an Amazon S3 bucket must start with https://. URLs from S3 static websites are not\n supported.
You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
The input for the SetStackPolicy action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#SetTypeConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#SetTypeConfigurationInput" }, "output": { "target": "com.amazonaws.cloudformation#SetTypeConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#CFNRegistryException" }, { "target": "com.amazonaws.cloudformation#TypeNotFoundException" } ], "traits": { "smithy.api#documentation": "Specifies the configuration data for a CloudFormation extension, such as a resource or Hook,\n in the given account and Region.
\nFor more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.
\nTo view the current configuration data for an extension, refer to the\n ConfigurationSchema element of DescribeType.
It's strongly recommended that you use dynamic references to restrict sensitive\n configuration definitions, such as third-party credentials. For more information, see Specify values stored in other services using dynamic references in the\n CloudFormation User Guide.
\nFor more information about setting the configuration data for resource types, see Defining the account-level configuration of an extension in the\n CloudFormation Command Line Interface (CLI) User Guide. For more information about setting the configuration\n data for Hooks, see the CloudFormation Hooks User Guide.
" } }, "com.amazonaws.cloudformation#SetTypeConfigurationInput": { "type": "structure", "members": { "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.
\nDo not include the extension versions suffix at the end of the ARN. You can set the\n configuration for an extension, but not for a specific extension version.
" } }, "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The configuration data for the extension in this account and Region.
\nThe configuration data must be formatted as JSON and validate against the extension's\n schema returned in the Schema response element of DescribeType.
An alias by which to refer to this extension configuration data.
\nConditional: Specifying a configuration alias is required when setting a configuration for\n a resource type extension.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "The name of the extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The type of extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The Amazon Resource Name (ARN) for the configuration data in this account and\n Region.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
Specify the default version of an extension. The default version of an extension will be\n used in CloudFormation operations.
", "smithy.api#idempotent": {} } }, "com.amazonaws.cloudformation#SetTypeDefaultVersionInput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension for which you want version summary\n information.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#SetTypeDefaultVersionOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#SignalResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#SignalResourceInput" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update\n policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the\n required number of signals or the timeout period is exceeded. The SignalResource\n operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2\n instance.
The stack name or unique stack ID that includes the resource that you want to\n signal.
", "smithy.api#required": {} } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The logical ID of the resource that you want to signal. The logical ID is the name of the\n resource that given in the template.
", "smithy.api#required": {} } }, "UniqueId": { "target": "com.amazonaws.cloudformation#ResourceSignalUniqueId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the\n instance ID that you are signaling as the unique ID. If you send multiple signals to a single\n resource (such as signaling a wait condition), each signal requires a different unique\n ID.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudformation#ResourceSignalStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes\n CloudFormation to immediately fail the stack creation or update.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The input for the SignalResource action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#SkippedStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#Stack": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "Unique identifier of the stack.
" } }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name associated with the stack.
", "smithy.api#required": {} } }, "ChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { "smithy.api#documentation": "The unique ID of the change set.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "A user-defined description associated with the stack.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { "smithy.api#documentation": "A list of Parameter structures.
The time at which the stack was created.
", "smithy.api#required": {} } }, "DeletionTime": { "target": "com.amazonaws.cloudformation#DeletionTime", "traits": { "smithy.api#documentation": "The time the stack was deleted.
" } }, "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been\n updated at least once.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "StackStatus": { "target": "com.amazonaws.cloudformation#StackStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Current status of the stack.
", "smithy.api#required": {} } }, "StackStatusReason": { "target": "com.amazonaws.cloudformation#StackStatusReason", "traits": { "smithy.api#documentation": "Success/failure message associated with the stack status.
" } }, "DisableRollback": { "target": "com.amazonaws.cloudformation#DisableRollback", "traits": { "smithy.api#documentation": "Boolean to enable or disable rollback on stack creation failures:
\n\n true: disable rollback.
\n false: enable rollback.
The deployment configuration for the stack, including the deployment mode used for stack\n operations.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { "smithy.api#documentation": "Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
" } }, "TimeoutInMinutes": { "target": "com.amazonaws.cloudformation#TimeoutMinutes", "traits": { "smithy.api#documentation": "The amount of time within which stack creation should complete.
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { "smithy.api#documentation": "The capabilities allowed in the stack.
" } }, "Outputs": { "target": "com.amazonaws.cloudformation#Outputs", "traits": { "smithy.api#documentation": "A list of output structures.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a\n stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { "smithy.api#documentation": "A list of Tags that specify information about the stack.
Whether termination protection is enabled for the stack.
\nFor nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack. For more information, see Protect a CloudFormation\n stack from being deleted in the CloudFormation User Guide.
" } }, "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "For nested stacks, the stack ID of the direct parent of this stack. For the first level of\n nested stacks, the root stack is also the parent stack.
\nFor more information, see Nested stacks in\n the CloudFormation User Guide.
" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately\n belongs.
\nFor more information, see Nested stacks in\n the CloudFormation User Guide.
" } }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformation", "traits": { "smithy.api#documentation": "Information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } }, "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { "smithy.api#documentation": "When set to true, newly created resources are deleted when the operation rolls\n back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
Specifies the deletion mode for the stack. Possible values are:
\n\n STANDARD - Use the standard behavior. Specifying this value is the same as\n not specifying this parameter.
\n FORCE_DELETE_STACK - Delete the stack if it's stuck in a\n DELETE_FAILED state due to resource deletion failure.
The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is\n present, the resource or resource configuration phase has completed and the stabilization of the\n resources is in progress. The StackSets CONFIGURATION_COMPLETE when all of the\n resources in the stack have reached that event. For more information, see Understand\n CloudFormation stack creation events in the CloudFormation User Guide.
Information about the most recent operations performed on this stack.
" } }, "AliasName": { "target": "com.amazonaws.cloudformation#AliasName", "traits": { "smithy.api#documentation": "The alias assigned to the stack, if one has been set. An alias is an alternative name that\n can be used in place of the stack name in any CloudFormation API call that accepts the\n StackName parameter.
The Stack data type.
The name associated with the stack.
" } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "The file path for the stack template file.
" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { "smithy.api#documentation": "The desired final state of the stack template.
" } } }, "traits": { "smithy.api#documentation": "Describes the stack and the template used by the stack.
" } }, "com.amazonaws.cloudformation#StackDefinitions": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackDefinition" } }, "com.amazonaws.cloudformation#StackDriftDetectionId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 36 } } }, "com.amazonaws.cloudformation#StackDriftDetectionStatus": { "type": "enum", "members": { "DETECTION_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DETECTION_IN_PROGRESS" } }, "DETECTION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DETECTION_FAILED" } }, "DETECTION_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DETECTION_COMPLETE" } } } }, "com.amazonaws.cloudformation#StackDriftDetectionStatusReason": { "type": "string" }, "com.amazonaws.cloudformation#StackDriftInformation": { "type": "structure", "members": { "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected template\n configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.
\n UNKNOWN: CloudFormation could not run drift detection for a resource in the\n stack.
Most recent time when a drift detection operation was initiated on the stack, or any of its\n individual resources that support drift detection.
" } } }, "traits": { "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. A stack is considered to have drifted if one or\n more of its resources have drifted.
" } }, "com.amazonaws.cloudformation#StackDriftInformationSummary": { "type": "structure", "members": { "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected template\n configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.
\n UNKNOWN: CloudFormation could not run drift detection for a resource in the\n stack.
Most recent time when a drift detection operation was initiated on the stack, or any of its\n individual resources that support drift detection.
" } } }, "traits": { "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. A stack is considered to have drifted if one or\n more of its resources have drifted.
" } }, "com.amazonaws.cloudformation#StackDriftStatus": { "type": "enum", "members": { "DRIFTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DRIFTED" } }, "IN_SYNC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_SYNC" } }, "UNKNOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN" } }, "NOT_CHECKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_CHECKED" } } } }, "com.amazonaws.cloudformation#StackEvent": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique ID name of the instance of the stack.
", "smithy.api#required": {} } }, "EventId": { "target": "com.amazonaws.cloudformation#EventId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique identifier of this event.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name associated with a stack.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#OperationId", "traits": { "smithy.api#documentation": "The unique identifier of the operation that generated this stack event.
" } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#documentation": "The logical name of the resource specified in the template.
" } }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "The name or unique identifier associated with the physical instance of the resource.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#documentation": "Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.
" } }, "Timestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Time the status was updated.
", "smithy.api#required": {} } }, "ResourceStatus": { "target": "com.amazonaws.cloudformation#ResourceStatus", "traits": { "smithy.api#documentation": "Current status of the resource.
" } }, "ResourceStatusReason": { "target": "com.amazonaws.cloudformation#ResourceStatusReason", "traits": { "smithy.api#documentation": "Success/failure message associated with the resource.
" } }, "ResourceProperties": { "target": "com.amazonaws.cloudformation#ResourceProperties", "traits": { "smithy.api#documentation": "BLOB of the properties used to create the resource.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request token,\n which you can use to track operations. For example, if you execute a CreateStack\n operation with the token token1, then all the StackEvents generated by\n that operation will have ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The name of the Hook.
" } }, "HookStatus": { "target": "com.amazonaws.cloudformation#HookStatus", "traits": { "smithy.api#documentation": "Provides the status of the change set Hook.
" } }, "HookStatusReason": { "target": "com.amazonaws.cloudformation#HookStatusReason", "traits": { "smithy.api#documentation": "Provides the reason for the Hook status.
" } }, "HookInvocationPoint": { "target": "com.amazonaws.cloudformation#HookInvocationPoint", "traits": { "smithy.api#documentation": "The specific point in the provisioning process where the Hook is invoked.
" } }, "HookInvocationId": { "target": "com.amazonaws.cloudformation#HookInvocationId", "traits": { "smithy.api#documentation": "The unique identifier of the Hook invocation.
" } }, "HookFailureMode": { "target": "com.amazonaws.cloudformation#HookFailureMode", "traits": { "smithy.api#documentation": "Specify the Hook failure mode for non-compliant resources in the followings ways.
\n\n FAIL Stops provisioning resources.
\n WARN Allows provisioning to continue with a warning message.
An optional field that contains information about the detailed status of the stack\n event.
\n\n CONFIGURATION_COMPLETE - all of the resources in the stack have reached that\n event. For more information, see Understand\n CloudFormation stack creation events in the CloudFormation User Guide.
\n VALIDATION_FAILED - template validation failed because of invalid properties\n in the template. The ResourceStatusReason field shows what properties are defined\n incorrectly.
The StackEvent data type.
The name or unique ID of the StackSet that the stack instance is associated with.
" } }, "Region": { "target": "com.amazonaws.cloudformation#Region", "traits": { "smithy.api#documentation": "The name of the Amazon Web Services Region that the stack instance is associated with.
" } }, "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is\n associated with.
" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "The ID of the stack instance.
" } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { "smithy.api#documentation": "A list of parameters from the StackSet template whose values have been overridden in this\n stack instance.
" } }, "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack\n set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.\n INOPERABLE can be returned here when the cause is a failed import. If it's due to\n a failed import, the operation can be retried once the failures are fixed. To see if this is\n due to a failed import, look at the DetailedStatus member in the\n StackInstanceSummary member that is a peer to this Status\n member.
\n OUTDATED: The stack isn't currently up to date with the StackSet\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the StackSet.
The detailed status of the stack instance.
" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#Reason", "traits": { "smithy.api#documentation": "The explanation for the specific status code that's assigned to this stack instance.
" } }, "OrganizationalUnitId": { "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" } }, "DriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#documentation": "Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the StackSet it belongs to.
\n\n DRIFTED: The stack differs from the expected template and parameter\n configuration of the StackSet it belongs to. A stack instance is considered to have drifted if\n one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected StackSet configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected\n StackSset configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the stack\n instance. This value will be NULL for any stack instance that drift detection hasn't\n yet been performed on.
The last unique ID of a StackSet operation performed on a stack instance.
" } } }, "traits": { "smithy.api#documentation": "A CloudFormation stack, in a specific account and Region, that's part of a StackSet operation. A\n stack instance is a reference to an attempted or actual stack in a given account within a given\n Region. A stack instance can exist without a stack\u2014for example, if the stack couldn't be created\n for some reason. A stack instance is associated with only one StackSet. Each stack instance\n contains the ID of its associated StackSet, in addition to the ID of the actual stack and the\n stack status.
" } }, "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { "type": "structure", "members": { "DetailedStatus": { "target": "com.amazonaws.cloudformation#StackInstanceDetailedStatus", "traits": { "smithy.api#documentation": "\n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the StackSet operation, or because the\n failure tolerance of the StackSet operation has been exceeded.
\n FAILED: The operation in the specified account and Region failed. If the\n StackSet operation fails in enough accounts within a Region, the failure tolerance for the\n StackSet operation as a whole might be exceeded.
\n FAILED_IMPORT: The import of the stack instance in the specified account and\n Region failed and left the stack in an unstable state. Once the issues causing the failure are\n fixed, the import operation can be retried. If enough StackSet operations fail in enough\n accounts within a Region, the failure tolerance for the StackSet operation as a whole might be\n exceeded.
\n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n PENDING: The operation in the specified account and Region has yet to\n start.
\n RUNNING: The operation in the specified account and Region is currently in\n progress.
\n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region\n has been skipped because the account was suspended at the time of the operation.
\n SUCCEEDED: The operation in the specified account and Region completed\n successfully.
The detailed status of the stack instance.
" } }, "com.amazonaws.cloudformation#StackInstanceDetailedStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } }, "INOPERABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INOPERABLE" } }, "SKIPPED_SUSPENDED_ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIPPED_SUSPENDED_ACCOUNT" } }, "FAILED_IMPORT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_IMPORT" } } } }, "com.amazonaws.cloudformation#StackInstanceFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudformation#StackInstanceFilterName", "traits": { "smithy.api#documentation": "The type of filter to apply.
" } }, "Values": { "target": "com.amazonaws.cloudformation#StackInstanceFilterValues", "traits": { "smithy.api#documentation": "The status to filter by.
" } } }, "traits": { "smithy.api#documentation": "The filter to apply to stack instances
" } }, "com.amazonaws.cloudformation#StackInstanceFilterName": { "type": "enum", "members": { "DETAILED_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DETAILED_STATUS" } }, "LAST_OPERATION_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LAST_OPERATION_ID" } }, "DRIFT_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DRIFT_STATUS" } } } }, "com.amazonaws.cloudformation#StackInstanceFilterValues": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^\\S{1,128}$" } }, "com.amazonaws.cloudformation#StackInstanceFilters": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackInstanceFilter" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.cloudformation#StackInstanceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "StackInstanceNotFoundException", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified stack instance doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummary" } }, "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummary": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the stack instance.
", "smithy.api#required": {} } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The logical name of the resource specified in the template.
", "smithy.api#required": {} } }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "PhysicalResourceIdContext": { "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", "traits": { "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough to\n uniquely identify that resource. Each context key-value pair specifies a unique resource that\n contains the targeted resource.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, "PropertyDifferences": { "target": "com.amazonaws.cloudformation#PropertyDifferences", "traits": { "smithy.api#documentation": "Status of the actual configuration of the resource compared to its expected configuration.\n These will be present only for resources whose StackInstanceResourceDriftStatus is\n MODIFIED.
The drift status of the resource in a stack instance.
\n\n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected template\n values.
\n IN_SYNC: The resource's actual configuration matches its expected template\n configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
Time at which the stack instance drift detection operation was initiated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The structure containing summary information about resource drifts for a stack\n instance.
" } }, "com.amazonaws.cloudformation#StackInstanceStatus": { "type": "enum", "members": { "CURRENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CURRENT" } }, "OUTDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OUTDATED" } }, "INOPERABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INOPERABLE" } } } }, "com.amazonaws.cloudformation#StackInstanceSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackInstanceSummary" } }, "com.amazonaws.cloudformation#StackInstanceSummary": { "type": "structure", "members": { "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { "smithy.api#documentation": "The name or unique ID of the StackSet that the stack instance is associated with.
" } }, "Region": { "target": "com.amazonaws.cloudformation#Region", "traits": { "smithy.api#documentation": "The name of the Amazon Web Services Region that the stack instance is associated with.
" } }, "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is\n associated with.
" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "The ID of the stack instance.
" } }, "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack\n set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.\n INOPERABLE can be returned here when the cause is a failed import. If it's due to\n a failed import, the operation can be retried once the failures are fixed. To see if this is\n due to a failed import, call the DescribeStackInstance API operation, look at\n the DetailedStatus member returned in the StackInstanceSummary\n member.
\n OUTDATED: The stack isn't currently up to date with the StackSet\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the StackSet.
The explanation for the specific status code assigned to this stack instance.
" } }, "StackInstanceStatus": { "target": "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus", "traits": { "smithy.api#documentation": "The detailed status of the stack instance.
" } }, "OrganizationalUnitId": { "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" } }, "DriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#documentation": "Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the StackSet it belongs to.
\n\n DRIFTED: The stack differs from the expected template and parameter\n configuration of the StackSet it belongs to. A stack instance is considered to have drifted if\n one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected StackSet configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected\n StackSet configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the stack\n instance. This value will be NULL for any stack instance that drift detection hasn't\n yet been performed on.
The last unique ID of a StackSet operation performed on a stack instance.
" } } }, "traits": { "smithy.api#documentation": "The structure that contains summary information about a stack instance.
" } }, "com.amazonaws.cloudformation#StackInstancesDeployment": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.cloudformation#StageStatus", "traits": { "smithy.api#documentation": "The status of the stack instances deployment stage can be one of the following values:
\n\n NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation.
\n NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached.
\n IN_PROGRESS: At least one stack instance has started deploying.
\n SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped.
\n PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances.
\n FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.
The number of stack instances that deployed successfully.
" } }, "FailedStackInstancesCount": { "target": "com.amazonaws.cloudformation#StackInstancesDeploymentFailedStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances that failed to deploy.
" } }, "CompletedStackInstancesCount": { "target": "com.amazonaws.cloudformation#CompletedStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances that have reached a final state. This count includes stack instances that succeeded, failed, were skipped, or were canceled.
" } }, "PendingStackInstancesCount": { "target": "com.amazonaws.cloudformation#PendingStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances that have not reached a final state. This is the total number of stack instances minus the completed count.
" } }, "CancelledStackInstancesCount": { "target": "com.amazonaws.cloudformation#CancelledStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances that were canceled because the operation exceeded its failure tolerance or was stopped.
" } }, "SkippedStackInstancesCount": { "target": "com.amazonaws.cloudformation#SkippedStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances that were skipped because role provisioning failed for their target account.
" } }, "PercentageCompleted": { "target": "com.amazonaws.cloudformation#StagePercentageCompleted", "traits": { "smithy.api#documentation": "The percentage of stack instances that have reached a final state.
" } } }, "traits": { "smithy.api#documentation": "Provides visibility into the stack instances deployment stage of a StackSet operation, including per-stack-instance progress counts and a completion percentage. For service-managed operations that provision roles, this stage begins after role provisioning finishes.
" } }, "com.amazonaws.cloudformation#StackInstancesDeploymentFailedStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#StackName": { "type": "string" }, "com.amazonaws.cloudformation#StackNameOrId": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)$" } }, "com.amazonaws.cloudformation#StackNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "StackNotFoundException", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudformation#StackPolicyBody": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16384 } } }, "com.amazonaws.cloudformation#StackPolicyDuringUpdateBody": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16384 } } }, "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5120 } } }, "com.amazonaws.cloudformation#StackPolicyURL": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5120 } } }, "com.amazonaws.cloudformation#StackRefactorAction": { "type": "structure", "members": { "Action": { "target": "com.amazonaws.cloudformation#StackRefactorActionType", "traits": { "smithy.api#documentation": "The action that CloudFormation takes on the stack.
" } }, "Entity": { "target": "com.amazonaws.cloudformation#StackRefactorActionEntity", "traits": { "smithy.api#documentation": "The type that will be evaluated in the StackRefactorAction. The following are\n potential Entity types:
\n Stack\n
\n Resource\n
The name or unique identifier associated with the physical instance of the resource.
" } }, "ResourceIdentifier": { "target": "com.amazonaws.cloudformation#StackRefactorResourceIdentifier", "traits": { "smithy.api#documentation": "A key-value pair that identifies the target resource. The key is an identifier property (for\n example, BucketName for AWS::S3::Bucket resources) and the value is the\n actual property value (for example, MyS3Bucket).
A description to help you identify the refactor.
" } }, "Detection": { "target": "com.amazonaws.cloudformation#StackRefactorDetection", "traits": { "smithy.api#documentation": "The detection type is one of the following:
\nAuto: CloudFormation figured out the mapping on its own.
\nManual: The customer provided the mapping in the ResourceMapping\n parameter.
The description of the detection type.
" } }, "TagResources": { "target": "com.amazonaws.cloudformation#StackRefactorTagResources", "traits": { "smithy.api#documentation": "Assigns one or more tags to specified resources.
" } }, "UntagResources": { "target": "com.amazonaws.cloudformation#StackRefactorUntagResources", "traits": { "smithy.api#documentation": "Removes one or more tags to specified resources.
" } }, "ResourceMapping": { "target": "com.amazonaws.cloudformation#ResourceMapping", "traits": { "smithy.api#documentation": "The mapping for the stack resource Source and stack resource\n Destination.
Describes the stack and the action that CloudFormation will perform on it if you execute the\n stack refactor.
" } }, "com.amazonaws.cloudformation#StackRefactorActionEntity": { "type": "enum", "members": { "RESOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE" } }, "STACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STACK" } } } }, "com.amazonaws.cloudformation#StackRefactorActionType": { "type": "enum", "members": { "MOVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MOVE" } }, "CREATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE" } } } }, "com.amazonaws.cloudformation#StackRefactorActions": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackRefactorAction" } }, "com.amazonaws.cloudformation#StackRefactorDetection": { "type": "enum", "members": { "AUTO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTO" } }, "MANUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANUAL" } } } }, "com.amazonaws.cloudformation#StackRefactorExecutionStatus": { "type": "enum", "members": { "UNAVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNAVAILABLE" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "OBSOLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OBSOLETE" } }, "EXECUTE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXECUTE_IN_PROGRESS" } }, "EXECUTE_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXECUTE_COMPLETE" } }, "EXECUTE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXECUTE_FAILED" } }, "ROLLBACK_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" } }, "ROLLBACK_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_COMPLETE" } }, "ROLLBACK_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_FAILED" } } } }, "com.amazonaws.cloudformation#StackRefactorExecutionStatusFilter": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackRefactorExecutionStatus" } }, "com.amazonaws.cloudformation#StackRefactorId": { "type": "string" }, "com.amazonaws.cloudformation#StackRefactorNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "StackRefactorNotFoundException", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified stack refactor can't be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudformation#StackRefactorResourceIdentifier": { "type": "string" }, "com.amazonaws.cloudformation#StackRefactorStatus": { "type": "enum", "members": { "CREATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, "CREATE_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_COMPLETE" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "DELETE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_IN_PROGRESS" } }, "DELETE_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_COMPLETE" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } } } }, "com.amazonaws.cloudformation#StackRefactorStatusReason": { "type": "string" }, "com.amazonaws.cloudformation#StackRefactorSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackRefactorSummary" } }, "com.amazonaws.cloudformation#StackRefactorSummary": { "type": "structure", "members": { "StackRefactorId": { "target": "com.amazonaws.cloudformation#StackRefactorId", "traits": { "smithy.api#documentation": "The ID associated with the stack refactor created from the CreateStackRefactor action.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "A description to help you identify the refactor.
" } }, "ExecutionStatus": { "target": "com.amazonaws.cloudformation#StackRefactorExecutionStatus", "traits": { "smithy.api#documentation": "The operation status that's provided after calling the ExecuteStackRefactor action.
" } }, "ExecutionStatusReason": { "target": "com.amazonaws.cloudformation#ExecutionStatusReason", "traits": { "smithy.api#documentation": "A detailed explanation for the stack refactor ExecutionStatus.
The stack refactor operation status that's provided after calling the CreateStackRefactor action.
" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#StackRefactorStatusReason", "traits": { "smithy.api#documentation": "A detailed explanation for the stack refactor Status.
The summary of a stack refactor operation.
" } }, "com.amazonaws.cloudformation#StackRefactorTagResources": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#Tag" } }, "com.amazonaws.cloudformation#StackRefactorUntagResources": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#TagKey" } }, "com.amazonaws.cloudformation#StackResource": { "type": "structure", "members": { "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#documentation": "The name associated with the stack.
" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "Unique identifier of the stack.
" } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The logical name of the resource specified in the template.
", "smithy.api#required": {} } }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, "Timestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Time the status was updated.
", "smithy.api#required": {} } }, "ResourceStatus": { "target": "com.amazonaws.cloudformation#ResourceStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Current status of the resource.
", "smithy.api#required": {} } }, "ResourceStatusReason": { "target": "com.amazonaws.cloudformation#ResourceStatusReason", "traits": { "smithy.api#documentation": "Success/failure message associated with the resource.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "User defined description associated with the resource.
" } }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", "traits": { "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } } }, "traits": { "smithy.api#documentation": "The StackResource data type.
The name associated with the stack.
" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "Unique identifier of the stack.
" } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The logical name of the resource specified in the template.
", "smithy.api#required": {} } }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, "LastUpdatedTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Time the status was updated.
", "smithy.api#required": {} } }, "ResourceStatus": { "target": "com.amazonaws.cloudformation#ResourceStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Current status of the resource.
", "smithy.api#required": {} } }, "ResourceStatusReason": { "target": "com.amazonaws.cloudformation#ResourceStatusReason", "traits": { "smithy.api#documentation": "Success/failure message associated with the resource.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "User defined description associated with the resource.
" } }, "Metadata": { "target": "com.amazonaws.cloudformation#Metadata", "traits": { "smithy.api#documentation": "The content of the Metadata attribute declared for the resource. For more\n information, see Metadata attribute\n in the CloudFormation User Guide.
Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } } }, "traits": { "smithy.api#documentation": "Contains detailed information about the specified stack resource.
" } }, "com.amazonaws.cloudformation#StackResourceDrift": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the stack.
", "smithy.api#required": {} } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The logical name of the resource specified in the template.
", "smithy.api#required": {} } }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "PhysicalResourceIdContext": { "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", "traits": { "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough to\n uniquely identify that resource. Each context key-value pair specifies a unique resource that\n contains the targeted resource.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of the resource.
", "smithy.api#required": {} } }, "ExpectedProperties": { "target": "com.amazonaws.cloudformation#Properties", "traits": { "smithy.api#documentation": "A JSON structure that contains the expected property values of the stack resource, as\n defined in the stack template and any values specified as template parameters.
\nFor resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.
A JSON structure that contains the actual property values of the stack resource.
\nFor resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.
A collection of the resource properties whose actual values differ from their expected\n values. These will be present only for resources whose StackResourceDriftStatus is\n MODIFIED.
Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected template configuration\n because the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected values\n (as defined in the stack template and any values specified as template parameters).
\n IN_SYNC: The resource's actual configuration matches its expected template\n configuration.
\n NOT_CHECKED: CloudFormation does not currently return this value.
\n UNKNOWN: CloudFormation could not run drift detection for the resource. See the\n DriftStatusReason for details.
Time at which CloudFormation performed drift detection on the stack resource.
", "smithy.api#required": {} } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } }, "DriftStatusReason": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatusReason", "traits": { "smithy.api#documentation": "The reason for the drift status.
" } } }, "traits": { "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This includes\n actual and expected property values for resources in which CloudFormation has detected drift. Only\n resource properties explicitly defined in the stack template are checked for drift. For more\n information, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.
\nResources that don't currently support drift detection can't be checked. For a list of\n resources that support drift detection, see Resource type\n support for imports and drift detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all resources in a given stack that\n support drift detection.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformation": { "type": "structure", "members": { "StackResourceDriftStatus": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration
\n\n DELETED: The resource differs from its expected configuration in that it has\n been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its\n expected configuration.
Any resources that do not currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resource\n type support for imports and drift detection.
\n IN_SYNC: The resource's actual configuration matches its expected\n configuration.
When CloudFormation last checked if the resource had drifted from its expected\n configuration.
" } } }, "traits": { "smithy.api#documentation": "Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformationSummary": { "type": "structure", "members": { "StackResourceDriftStatus": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected configuration in that it has\n been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its\n expected configuration.
Any resources that don't currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resource\n type support for imports and drift detection. If you performed a ContinueUpdateRollback operation on a stack, resources skipped using\n ResourcesToSkip or ForceRollback also have a status of\n NOT_CHECKED. To detect whether a skipped resource actually differs from the\n template, run DetectStackResourceDrift. For more information about\n skipping resources during rollback operations, see Continue rolling back an update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected\n configuration.
When CloudFormation last checked if the resource had drifted from its expected\n configuration.
" } } }, "traits": { "smithy.api#documentation": "Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftStatus": { "type": "enum", "members": { "IN_SYNC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_SYNC" } }, "MODIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MODIFIED" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "NOT_CHECKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_CHECKED" } }, "UNKNOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN" } }, "UNSUPPORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED" } } } }, "com.amazonaws.cloudformation#StackResourceDriftStatusFilters": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatus" }, "traits": { "smithy.api#length": { "min": 1, "max": 4 } } }, "com.amazonaws.cloudformation#StackResourceDriftStatusReason": { "type": "string" }, "com.amazonaws.cloudformation#StackResourceDrifts": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackResourceDrift" } }, "com.amazonaws.cloudformation#StackResourceSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackResourceSummary" } }, "com.amazonaws.cloudformation#StackResourceSummary": { "type": "structure", "members": { "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The logical name of the resource specified in the template.
", "smithy.api#required": {} } }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of the\n resource.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Type of resource. (For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.)
", "smithy.api#required": {} } }, "LastUpdatedTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Time the status was updated.
", "smithy.api#required": {} } }, "ResourceStatus": { "target": "com.amazonaws.cloudformation#ResourceStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Current status of the resource.
", "smithy.api#required": {} } }, "ResourceStatusReason": { "target": "com.amazonaws.cloudformation#ResourceStatusReason", "traits": { "smithy.api#documentation": "Success/failure message associated with the resource.
" } }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackResourceDriftInformationSummary", "traits": { "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } } }, "traits": { "smithy.api#documentation": "Contains high-level information about the specified stack resource.
" } }, "com.amazonaws.cloudformation#StackResources": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackResource" } }, "com.amazonaws.cloudformation#StackSet": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#documentation": "The name that's associated with the StackSet.
" } }, "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { "smithy.api#documentation": "The ID of the StackSet.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "A description of the StackSet that you specify when the StackSet is created or\n updated.
" } }, "Status": { "target": "com.amazonaws.cloudformation#StackSetStatus", "traits": { "smithy.api#documentation": "The status of the StackSet.
" } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "The structure that contains the body of the template that was used to create or update the\n StackSet.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { "smithy.api#documentation": "A list of input parameters for a StackSet.
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { "smithy.api#documentation": "The capabilities that are allowed in the StackSet. Some StackSet templates might include\n resources that can affect permissions in your Amazon Web Services account\u2014for example, by creating new\n Identity and Access Management (IAM) users. For more information, see Acknowledging IAM resources in CloudFormation templates.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { "smithy.api#documentation": "A list of tags that specify information about the StackSet. A maximum number of 50 tags can\n be specified.
" } }, "StackSetARN": { "target": "com.amazonaws.cloudformation#StackSetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the StackSet.
" } }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack\n set.
\nUse customized administrator roles to control which users or groups can manage specific\n StackSets within the same administrator account. For more information, see Prerequisites for using CloudFormation StackSets in the\n CloudFormation User Guide.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { "smithy.api#documentation": "The name of the IAM execution role used to create or update the StackSet.
\nUse customized execution roles to control which stack resources users and groups can include\n in their StackSets.
" } }, "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { "smithy.api#documentation": "Detailed information about the drift status of the StackSet.
\nFor StackSets, contains information about the last completed drift\n operation performed on the StackSet. Information about drift operations currently in progress\n isn't included.
" } }, "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { "smithy.api#documentation": "Describes whether StackSets automatically deploys to Organizations accounts that are\n added to a target organization or organizational unit (OU). Valid only if the StackSet uses\n service-managed permissions.
" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { "smithy.api#documentation": "Describes how the IAM roles required for StackSet operations are created.
\nWith self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n self-managed permissions.
With service-managed permissions, StackSets automatically creates the IAM\n roles required to deploy to accounts managed by Organizations. For more information,\n see Activate\n trusted access for StackSets with Organizations.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" } }, "ManagedExecution": { "target": "com.amazonaws.cloudformation#ManagedExecution", "traits": { "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" } }, "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { "smithy.api#documentation": "Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The\n Amazon Web Services Regions list output is in no particular order.
" } }, "StackSetOutputBucketPath": { "target": "com.amazonaws.cloudformation#StackSetOutputBucketPath", "traits": { "smithy.api#documentation": "The Amazon S3 bucket path where CloudFormation stores the execution role stack template body. CloudFormation uses this bucket only when you specify a custom execution role template.
" } } }, "traits": { "smithy.api#documentation": "A structure that contains information about a StackSet. With StackSets, you can provision\n stacks across Amazon Web Services accounts and Regions from a single CloudFormation template. Each stack is based\n on the same CloudFormation template, but you can customize individual stacks using parameters.
" } }, "com.amazonaws.cloudformation#StackSetARN": { "type": "string" }, "com.amazonaws.cloudformation#StackSetARNList": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackSetARN" } }, "com.amazonaws.cloudformation#StackSetAutoDeploymentTargetSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackSetAutoDeploymentTargetSummary" } }, "com.amazonaws.cloudformation#StackSetAutoDeploymentTargetSummary": { "type": "structure", "members": { "OrganizationalUnitId": { "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { "smithy.api#documentation": "The organization root ID or organizational unit (OU) IDs where the StackSet is\n targeted.
" } }, "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { "smithy.api#documentation": "The list of Regions targeted for this organization or OU.
" } } }, "traits": { "smithy.api#documentation": "One of the targets for the StackSet. Returned by the ListStackSetAutoDeploymentTargets API operation.
" } }, "com.amazonaws.cloudformation#StackSetDriftDetectionDetails": { "type": "structure", "members": { "DriftStatus": { "target": "com.amazonaws.cloudformation#StackSetDriftStatus", "traits": { "smithy.api#documentation": "Status of the StackSet's actual configuration compared to its expected template and\n parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the StackSet differs\n from the expected template and parameter configuration. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.
\n IN_SYNC: All of the stack instances belonging to the StackSet stack match the\n expected template and parameter configuration.
The status of the StackSet drift detection operation.
\n\n COMPLETED: The drift detection operation completed without failing on any\n stack instances.
\n FAILED: The drift detection operation exceeded the specified failure\n tolerance.
\n PARTIAL_SUCCESS: The drift detection operation completed without exceeding\n the failure tolerance for the operation.
\n IN_PROGRESS: The drift detection operation is currently being\n performed.
\n STOPPED: The user has canceled the drift detection operation.
Most recent time when CloudFormation performed a drift detection operation on the StackSet. This\n value will be NULL for any StackSet that drift detection hasn't yet been performed\n on.
The total number of stack instances belonging to this StackSet.
\nThe total number of stack instances is equal to the total of:
\nStack instances that match the StackSet configuration.
\nStack instances that have drifted from the StackSet configuration.
\nStack instances where the drift detection operation has failed.
\nStack instances currently being checked for drift.
\nThe number of stack instances that have drifted from the expected template and parameter\n configuration of the StackSet. A stack instance is considered to have drifted if one or more of\n the resources in the associated stack don't match their expected configuration.
" } }, "InSyncStackInstancesCount": { "target": "com.amazonaws.cloudformation#InSyncStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances which match the expected template and parameter configuration\n of the StackSet.
" } }, "InProgressStackInstancesCount": { "target": "com.amazonaws.cloudformation#InProgressStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances that are currently being checked for drift.
" } }, "FailedStackInstancesCount": { "target": "com.amazonaws.cloudformation#FailedStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances for which the drift detection operation failed.
" } } }, "traits": { "smithy.api#documentation": "Detailed information about the drift status of the StackSet.
\nFor StackSets, contains information about the last completed drift\n operation performed on the StackSet. Information about drift operations in-progress isn't\n included.
\nFor StackSet operations, includes information about drift operations currently being\n performed on the StackSet.
\nFor more information, see Performing drift detection on\n CloudFormation StackSets in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#StackSetDriftDetectionStatus": { "type": "enum", "members": { "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "PARTIAL_SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL_SUCCESS" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } } } }, "com.amazonaws.cloudformation#StackSetDriftStatus": { "type": "enum", "members": { "DRIFTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DRIFTED" } }, "IN_SYNC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_SYNC" } }, "NOT_CHECKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_CHECKED" } } } }, "com.amazonaws.cloudformation#StackSetId": { "type": "string" }, "com.amazonaws.cloudformation#StackSetName": { "type": "string" }, "com.amazonaws.cloudformation#StackSetNameOrId": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?$" } }, "com.amazonaws.cloudformation#StackSetNotEmptyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "StackSetNotEmptyException", "httpResponseCode": 409 }, "smithy.api#documentation": "You can't yet delete this StackSet, because it still contains one or more stack instances. Delete all stack\n instances from the StackSet before deleting the StackSet.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudformation#StackSetNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "StackSetNotFoundException", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified StackSet doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudformation#StackSetOperation": { "type": "structure", "members": { "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique ID of a StackSet operation.
" } }, "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { "smithy.api#documentation": "The ID of the StackSet.
" } }, "Action": { "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { "smithy.api#documentation": "The type of StackSet operation: CREATE, UPDATE, or\n DELETE. Create and delete operations affect only the specified stack instances that\n are associated with the specified StackSet. Update operations affect both the StackSet itself, in\n addition to all associated stack instances.
The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels\n the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the StackSets status codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.
The preferences for how CloudFormation performs this StackSet operation.
" } }, "RetainStacks": { "target": "com.amazonaws.cloudformation#RetainStacksNullable", "traits": { "smithy.api#documentation": "For StackSet operations of action type DELETE, specifies whether to remove the\n stack instances from the specified StackSet, but doesn't delete the stacks. You can't\n re-associate a retained stack, or add an existing, saved stack to a new StackSet.
The Amazon Resource Name (ARN) of the IAM role used to perform this StackSet\n operation.
\nUse customized administrator roles to control which users or groups can manage specific\n StackSets within the same administrator account. For more information, see Grant self-managed\n permissions in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { "smithy.api#documentation": "The name of the IAM execution role used to create or update the StackSet.
\nUse customized execution roles to control which stack resources users and groups can include\n in their StackSets.
" } }, "CreationTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the stack\n set operation might differ from the creation time of the individual stacks themselves. This is\n because CloudFormation needs to perform preparatory work for the operation, such as dispatching the\n work to the requested Regions, before actually creating the first stacks.
" } }, "EndTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The time at which the StackSet operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the StackSet operation was successful, or even\n attempted, in each account or Region.
" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { "smithy.api#documentation": "The Organizations accounts affected by the stack operation. Valid only if the\n StackSet uses service-managed permissions.
" } }, "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { "smithy.api#documentation": "Detailed information about the drift status of the StackSet. This includes information about\n drift operations currently being performed on the StackSet.
\nThis information will only be present for StackSet operations whose Action type\n is DETECT_DRIFT.
For more information, see Performing drift detection on\n CloudFormation StackSets in the CloudFormation User Guide.
" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", "traits": { "smithy.api#documentation": "The status of the operation in details.
" } }, "StatusDetails": { "target": "com.amazonaws.cloudformation#StackSetOperationStatusDetails", "traits": { "smithy.api#documentation": "Detailed information about the StackSet operation.
" } }, "RegionalStatusDetails": { "target": "com.amazonaws.cloudformation#RegionalStatusDetails", "traits": { "smithy.api#documentation": "The progress detail for each Region of the operation, keyed by Region. Each entry reports the stack instances deployment progress for that Region. This field is returned only by DescribeStackSetOperation. It is not included in the ListStackSetOperations summary.
" } } }, "traits": { "smithy.api#documentation": "The structure that contains information about a StackSet operation.
" } }, "com.amazonaws.cloudformation#StackSetOperationAction": { "type": "enum", "members": { "CREATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE" } }, "UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE" } }, "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } }, "DETECT_DRIFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DETECT_DRIFT" } } } }, "com.amazonaws.cloudformation#StackSetOperationPreferences": { "type": "structure", "members": { "RegionConcurrencyType": { "target": "com.amazonaws.cloudformation#RegionConcurrencyType", "traits": { "smithy.api#documentation": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or\n one Region at a time.
" } }, "RegionOrder": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { "smithy.api#documentation": "The order of the Regions where you want to perform the stack operation.
" } }, "FailureToleranceCount": { "target": "com.amazonaws.cloudformation#FailureToleranceCount", "traits": { "smithy.api#documentation": "The number of accounts per Region this operation can fail in before CloudFormation stops the\n operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the\n operation in any subsequent Regions.
\nYou can specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The percentage of accounts per Region this stack operation can fail in before CloudFormation\n stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't\n attempt the operation in any subsequent Regions.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds\n down to the next whole number.
\nYou can specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The maximum number of accounts in which to perform this operation at one time. This can\n depend on the value of FailureToleranceCount depending on your\n ConcurrencyMode. MaxConcurrentCount is at most one more than the\n FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For\n large deployments, under certain circumstances the actual number of accounts acted upon\n concurrently may be lower due to service throttling.
\nYou can specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds\n down to the next whole number. This is true except in cases where rounding down would result is\n zero. In this case, CloudFormation sets the number as one instead.
\nNote that this setting lets you specify the maximum for operations. For\n large deployments, under certain circumstances the actual number of accounts acted upon\n concurrently may be lower due to service throttling.
\nYou can specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
Specifies how the concurrency level behaves during the operation execution.
\n\n STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency\n level to ensure the number of failed accounts never exceeds the value of\n FailureToleranceCount +1. The initial actual concurrency is set to the lower of\n either the value of the MaxConcurrentCount, or the value of\n FailureToleranceCount +1. The actual concurrency is then reduced proportionally\n by the number of failures. This is the default behavior.
If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior\n is similar.
\n\n SOFT_FAILURE_TOLERANCE: This option decouples\n FailureToleranceCount from the actual concurrency. This allows StackSet\n operations to run at the concurrency level set by the MaxConcurrentCount value, or\n MaxConcurrentPercentage, regardless of the number of failures.
The user-specified preferences for how CloudFormation performs a StackSet operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see StackSet\n operation options.
\n\n StackSetOperationPreferences don't apply to AutoDeployment, even\n if it's enabled.
[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
" } }, "Region": { "target": "com.amazonaws.cloudformation#Region", "traits": { "smithy.api#documentation": "The name of the Amazon Web Services Region for this operation result.
" } }, "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationResultStatus", "traits": { "smithy.api#documentation": "The result status of the StackSet operation for the given account in the given\n Region.
\n\n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the StackSet operation, or because the\n failure tolerance of the StackSet operation has been exceeded.
\n FAILED: The operation in the specified account and Region failed.
If the StackSet operation fails in enough accounts within a Region, the failure tolerance\n for the StackSet operation as a whole might be exceeded.
\n\n RUNNING: The operation in the specified account and Region is currently in\n progress.
\n PENDING: The operation in the specified account and Region has yet to\n start.
\n SUCCEEDED: The operation in the specified account and Region completed\n successfully.
The reason for the assigned result status.
" } }, "AccountGateResult": { "target": "com.amazonaws.cloudformation#AccountGateResult", "traits": { "smithy.api#documentation": "The results of the account gate function CloudFormation invokes, if present, before proceeding\n with StackSet operations in an account.
" } }, "OrganizationalUnitId": { "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" } } }, "traits": { "smithy.api#documentation": "The structure that contains information about a specified operation's results for a given\n account in a given Region.
" } }, "com.amazonaws.cloudformation#StackSetOperationStatus": { "type": "enum", "members": { "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } }, "QUEUED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUEUED" } } } }, "com.amazonaws.cloudformation#StackSetOperationStatusDetails": { "type": "structure", "members": { "Stages": { "target": "com.amazonaws.cloudformation#Stages", "traits": { "smithy.api#documentation": "The detailed progress information for the individual stages of the StackSet operation: the role provisioning stage and the stack instances deployment stage.
" } }, "TotalAccountsCount": { "target": "com.amazonaws.cloudformation#TotalAccountsCount", "traits": { "smithy.api#documentation": "The total number of accounts targeted by this StackSet operation. Self-managed operations and service-managed operations that do not provision roles also report this value when it is known. CloudFormation populates this value after it resolves the target accounts. Until then, this field is not present.
" } }, "TotalStackInstancesCount": { "target": "com.amazonaws.cloudformation#StackSetOperationTotalStackInstancesCount", "traits": { "smithy.api#documentation": "The total number of stack instances targeted by this StackSet operation. CloudFormation populates this value after it resolves the target stack instances. Until then, this field is not present.
" } }, "FailedStackInstancesCount": { "target": "com.amazonaws.cloudformation#FailedStackInstancesCount", "traits": { "smithy.api#documentation": "The number of stack instances for which the StackSet operation failed.
" } } }, "traits": { "smithy.api#documentation": "Detailed information about the StackSet operation.
" } }, "com.amazonaws.cloudformation#StackSetOperationStatusReason": { "type": "string" }, "com.amazonaws.cloudformation#StackSetOperationSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackSetOperationSummary" } }, "com.amazonaws.cloudformation#StackSetOperationSummary": { "type": "structure", "members": { "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique ID of the StackSet operation.
" } }, "Action": { "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { "smithy.api#documentation": "The type of operation: CREATE, UPDATE, or DELETE.\n Create and delete operations affect only the specified stack instances that are associated with\n the specified StackSet. Update operations affect both the StackSet itself and\n all associated StackSet instances.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels\n the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the StackSet status codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.
The time at which the operation was initiated. Note that the creation times for the StackSet\n operation might differ from the creation time of the individual stacks themselves. This is\n because CloudFormation needs to perform preparatory work for the operation, such as dispatching the\n work to the requested Regions, before actually creating the first stacks.
" } }, "EndTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "The time at which the StackSet operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the StackSet operation was successful, or even\n attempted, in each account or Region.
" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", "traits": { "smithy.api#documentation": "The status of the operation in details.
" } }, "StatusDetails": { "target": "com.amazonaws.cloudformation#StackSetOperationStatusDetails", "traits": { "smithy.api#documentation": "Detailed information about the StackSet operation.
" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a StackSet operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see StackSet\n operation options.
" } } }, "traits": { "smithy.api#documentation": "The structures that contain summary information about the specified operation.
" } }, "com.amazonaws.cloudformation#StackSetOperationTotalStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#StackSetOutputBucket": { "type": "string" }, "com.amazonaws.cloudformation#StackSetOutputBucketPath": { "type": "string" }, "com.amazonaws.cloudformation#StackSetStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.cloudformation#StackSetSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackSetSummary" } }, "com.amazonaws.cloudformation#StackSetSummary": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#documentation": "The name of the StackSet.
" } }, "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { "smithy.api#documentation": "The ID of the StackSet.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "A description of the StackSet that you specify when the StackSet is created or\n updated.
" } }, "Status": { "target": "com.amazonaws.cloudformation#StackSetStatus", "traits": { "smithy.api#documentation": "The status of the StackSet.
" } }, "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).
" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { "smithy.api#documentation": "Describes how the IAM roles required for StackSet operations are created.
\nWith self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n self-managed permissions.
With service-managed permissions, StackSets automatically creates the IAM\n roles required to deploy to accounts managed by Organizations. For more information,\n see Activate\n trusted access for StackSets with Organizations.
Status of the StackSet's actual configuration compared to its expected template and\n parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the StackSet differs\n from the expected template and parameter configuration. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.
\n IN_SYNC: All the stack instances belonging to the StackSet match the expected\n template and parameter configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the StackSet. This\n value will be NULL for any StackSet that drift detection hasn't yet been performed\n on.
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" } } }, "traits": { "smithy.api#documentation": "The structures that contain summary information about the specified StackSet.
" } }, "com.amazonaws.cloudformation#StackStatus": { "type": "enum", "members": { "CREATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "CREATE_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_COMPLETE" } }, "ROLLBACK_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" } }, "ROLLBACK_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_FAILED" } }, "ROLLBACK_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_COMPLETE" } }, "DELETE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_IN_PROGRESS" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } }, "DELETE_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_COMPLETE" } }, "UPDATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_IN_PROGRESS" } }, "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" } }, "UPDATE_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_COMPLETE" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } }, "UPDATE_ROLLBACK_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_ROLLBACK_IN_PROGRESS" } }, "UPDATE_ROLLBACK_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_ROLLBACK_FAILED" } }, "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS" } }, "UPDATE_ROLLBACK_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_ROLLBACK_COMPLETE" } }, "REVIEW_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVIEW_IN_PROGRESS" } }, "IMPORT_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORT_IN_PROGRESS" } }, "IMPORT_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORT_COMPLETE" } }, "IMPORT_ROLLBACK_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORT_ROLLBACK_IN_PROGRESS" } }, "IMPORT_ROLLBACK_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORT_ROLLBACK_FAILED" } }, "IMPORT_ROLLBACK_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORT_ROLLBACK_COMPLETE" } } } }, "com.amazonaws.cloudformation#StackStatusFilter": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackStatus" } }, "com.amazonaws.cloudformation#StackStatusReason": { "type": "string" }, "com.amazonaws.cloudformation#StackSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#StackSummary" } }, "com.amazonaws.cloudformation#StackSummary": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "Unique stack identifier.
" } }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name associated with the stack.
", "smithy.api#required": {} } }, "TemplateDescription": { "target": "com.amazonaws.cloudformation#TemplateDescription", "traits": { "smithy.api#documentation": "The template description of the template used to create the stack.
" } }, "CreationTime": { "target": "com.amazonaws.cloudformation#CreationTime", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The time the stack was created.
", "smithy.api#required": {} } }, "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been\n updated at least once.
" } }, "DeletionTime": { "target": "com.amazonaws.cloudformation#DeletionTime", "traits": { "smithy.api#documentation": "The time the stack was deleted.
" } }, "StackStatus": { "target": "com.amazonaws.cloudformation#StackStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The current status of the stack.
", "smithy.api#required": {} } }, "StackStatusReason": { "target": "com.amazonaws.cloudformation#StackStatusReason", "traits": { "smithy.api#documentation": "Success/Failure message associated with the stack status.
" } }, "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "For nested stacks, the stack ID of the direct parent of this stack. For the first level of\n nested stacks, the root stack is also the parent stack.
\nFor more information, see Nested stacks in\n the CloudFormation User Guide.
" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately\n belongs.
\nFor more information, see Nested stacks in\n the CloudFormation User Guide.
" } }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", "traits": { "smithy.api#documentation": "Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } }, "LastOperations": { "target": "com.amazonaws.cloudformation#LastOperations", "traits": { "smithy.api#documentation": "Information about the most recent operations performed on this stack.
" } } }, "traits": { "smithy.api#documentation": "The StackSummary Data Type
The progress detail for the role provisioning stage. For operations that do not provision roles, this stage is present with a Status of NOT_APPLICABLE.
The progress detail for the stack instances deployment stage. This stage reports the deployment of stack instances to the target accounts and Amazon Web Services Regions, after any role provisioning has finished.
" } } }, "traits": { "smithy.api#documentation": "Contains detailed progress information for the individual stages of a StackSet operation: the role provisioning stage and the stack instances deployment stage.
" } }, "com.amazonaws.cloudformation#StaleRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "StaleRequestException", "httpResponseCode": 409 }, "smithy.api#documentation": "Another operation has been performed on this StackSet since the specified operation was performed.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudformation#StartResourceScan": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#StartResourceScanInput" }, "output": { "target": "com.amazonaws.cloudformation#StartResourceScanOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#ResourceScanInProgressException" }, { "target": "com.amazonaws.cloudformation#ResourceScanLimitExceededException" } ], "traits": { "smithy.api#documentation": "Starts a scan of the resources in this account in this Region. You can the status of a\n scan using the ListResourceScans API action.
A unique identifier for this StartResourceScan request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to start a new\n resource scan.
The scan filters to use.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#StartResourceScanOutput": { "type": "structure", "members": { "ResourceScanId": { "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An\n example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .
Stops an in-progress operation on a StackSet and its associated stack instances. StackSets\n will cancel all the unstarted stack instance deployments and wait for those are in-progress to\n complete.
" } }, "com.amazonaws.cloudformation#StopStackSetOperationInput": { "type": "structure", "members": { "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or unique ID of the StackSet that you want to stop the operation for.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the stack operation.
", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid only if the\n StackSet uses service-managed permissions.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA string used to identify this tag. You can specify a maximum of 128 characters for a tag\n key. Tags owned by Amazon Web Services have the reserved prefix: aws:.
A string that contains the value for this tag. You can specify a maximum of 256 characters\n for a tag value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The Tag type enables you to specify a key-value pair that can be used to store information\n about an CloudFormation stack.
" } }, "com.amazonaws.cloudformation#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.cloudformation#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.cloudformation#Tags": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.cloudformation#TemplateBody": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.cloudformation#TemplateConfiguration": { "type": "structure", "members": { "DeletionPolicy": { "target": "com.amazonaws.cloudformation#GeneratedTemplateDeletionPolicy", "traits": { "smithy.api#documentation": "The DeletionPolicy assigned to resources in the generated template. Supported\n values are:
\n DELETE - delete all resources when the stack is deleted.
\n RETAIN - retain all resources when the stack is deleted.
For more information, see DeletionPolicy\n attribute in the CloudFormation User Guide.
" } }, "UpdateReplacePolicy": { "target": "com.amazonaws.cloudformation#GeneratedTemplateUpdateReplacePolicy", "traits": { "smithy.api#documentation": "The UpdateReplacePolicy assigned to resources in the generated template.\n Supported values are:
\n DELETE - delete all resources when the resource is replaced during an update\n operation.
\n RETAIN - retain all resources when the resource is replaced during an update\n operation.
For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.
" } } }, "traits": { "smithy.api#documentation": "The configuration details of a generated template.
" } }, "com.amazonaws.cloudformation#TemplateDescription": { "type": "string" }, "com.amazonaws.cloudformation#TemplateFormat": { "type": "enum", "members": { "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSON" } }, "YAML": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "YAML" } } } }, "com.amazonaws.cloudformation#TemplateParameter": { "type": "structure", "members": { "ParameterKey": { "target": "com.amazonaws.cloudformation#ParameterKey", "traits": { "smithy.api#documentation": "The name associated with the parameter.
" } }, "DefaultValue": { "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { "smithy.api#documentation": "The default value associated with the parameter.
" } }, "NoEcho": { "target": "com.amazonaws.cloudformation#NoEcho", "traits": { "smithy.api#documentation": "Flag indicating whether the parameter should be displayed as plain text in logs and\n UIs.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "User defined description associated with the parameter.
" } } }, "traits": { "smithy.api#documentation": "The TemplateParameter data type.
The number of resources that succeeded the template generation.
" } }, "ResourcesFailed": { "target": "com.amazonaws.cloudformation#ResourcesFailed", "traits": { "smithy.api#documentation": "The number of resources that failed the template generation.
" } }, "ResourcesProcessing": { "target": "com.amazonaws.cloudformation#ResourcesProcessing", "traits": { "smithy.api#documentation": "The number of resources that are in-process for the template generation.
" } }, "ResourcesPending": { "target": "com.amazonaws.cloudformation#ResourcesPending", "traits": { "smithy.api#documentation": "The number of resources that are still pending the template generation.
" } } }, "traits": { "smithy.api#documentation": "A summary of the progress of the template generation.
" } }, "com.amazonaws.cloudformation#TemplateStage": { "type": "enum", "members": { "Original": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Original" } }, "Processed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Processed" } } } }, "com.amazonaws.cloudformation#TemplateStatusReason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.cloudformation#TemplateSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#TemplateSummary" } }, "com.amazonaws.cloudformation#TemplateSummary": { "type": "structure", "members": { "GeneratedTemplateId": { "target": "com.amazonaws.cloudformation#GeneratedTemplateId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For\n example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
The name of the generated template.
" } }, "Status": { "target": "com.amazonaws.cloudformation#GeneratedTemplateStatus", "traits": { "smithy.api#documentation": "The status of the template generation. Supported values are:
\n\n CreatePending - the creation of the template is pending.
\n CreateInProgress - the creation of the template is in progress.
\n DeletePending - the deletion of the template is pending.
\n DeleteInProgress - the deletion of the template is in progress.
\n UpdatePending - the update of the template is pending.
\n UpdateInProgress - the update of the template is in progress.
\n Failed - the template operation failed.
\n Complete - the template operation is complete.
The reason for the current template generation status. This will provide more details if a\n failure happened.
" } }, "CreationTime": { "target": "com.amazonaws.cloudformation#CreationTime", "traits": { "smithy.api#documentation": "The time the generated template was created.
" } }, "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { "smithy.api#documentation": "The time the generated template was last updated.
" } }, "NumberOfResources": { "target": "com.amazonaws.cloudformation#NumberOfResources", "traits": { "smithy.api#documentation": "The number of resources in the generated template. This is a total of resources in pending,\n in-progress, completed, and failed states.
" } } }, "traits": { "smithy.api#documentation": "The summary of a generated template.
" } }, "com.amazonaws.cloudformation#TemplateSummaryConfig": { "type": "structure", "members": { "TreatUnrecognizedResourceTypesAsWarnings": { "target": "com.amazonaws.cloudformation#TreatUnrecognizedResourceTypesAsWarnings", "traits": { "smithy.api#documentation": "If set to True, any unrecognized resource types generate warnings and not an\n error. Any unrecognized resource types are returned in the Warnings output\n parameter.
Options for the GetTemplateSummary API action.
Tests a registered extension to make sure it meets all necessary requirements for being\n published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the\n type.
\nFor modules, this includes determining if the module's model meets all necessary\n requirements.
\nFor more information, see Testing your public extension before publishing in the\n CloudFormation Command Line Interface (CLI) User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in\n your account and Region for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was\n registered. For more information, see RegisterType.
\nOnce you've initiated testing on an extension using TestType, you can pass\n the returned TypeVersionArn into DescribeType to\n 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.\n For more information, see Publishing extensions\n to make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The type of the extension to test.
\nConditional: You must specify Arn, or TypeName and\n Type.
The name of the extension to test.
\nConditional: You must specify Arn, or TypeName and\n Type.
The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName\n and Type.
If you don't specify a version, CloudFormation uses the default version of the extension in\n this account and Region for testing.
" } }, "LogDeliveryBucket": { "target": "com.amazonaws.cloudformation#S3Bucket", "traits": { "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension\n has been assigned a test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3\n bucket. Specifically, the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and\n Condition Keys for Amazon S3 in the Identity and Access Management User Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#TestTypeOutput": { "type": "structure", "members": { "TypeVersionArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#ThirdPartyType": { "type": "enum", "members": { "RESOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE" } }, "MODULE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MODULE" } }, "HOOK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOOK" } } } }, "com.amazonaws.cloudformation#ThirdPartyTypeArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}::type/.+/[0-9a-zA-Z]{12,40}/.+$" } }, "com.amazonaws.cloudformation#TimeoutMinutes": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.cloudformation#Timestamp": { "type": "timestamp" }, "com.amazonaws.cloudformation#TokenAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TokenAlreadyExistsException", "httpResponseCode": 400 }, "smithy.api#documentation": "A client request token already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudformation#TotalAccountsCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#TotalStackInstancesCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#TotalWarnings": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cloudformation#TransformName": { "type": "string" }, "com.amazonaws.cloudformation#TransformsList": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#TransformName" } }, "com.amazonaws.cloudformation#TreatUnrecognizedResourceTypesAsWarnings": { "type": "boolean" }, "com.amazonaws.cloudformation#Type": { "type": "string" }, "com.amazonaws.cloudformation#TypeArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+$" } }, "com.amazonaws.cloudformation#TypeConfiguration": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 204800 }, "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.cloudformation#TypeConfigurationAlias": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9]{1,256}$" } }, "com.amazonaws.cloudformation#TypeConfigurationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type-configuration/.+$" } }, "com.amazonaws.cloudformation#TypeConfigurationDetails": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.cloudformation#TypeConfigurationArn", "traits": { "smithy.api#documentation": "The ARN for the configuration data, in this account and Region.
" } }, "Alias": { "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", "traits": { "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was\n set.
" } }, "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { "smithy.api#documentation": "A JSON string specifying the configuration data for the extension, in this account and\n Region.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n {}.
When the configuration data was last updated for this extension.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n null.
The ARN for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "The name of the extension.
" } }, "IsDefaultConfiguration": { "target": "com.amazonaws.cloudformation#IsDefaultConfiguration", "traits": { "smithy.api#documentation": "Whether this configuration data is the default configuration for the extension.
" } } }, "traits": { "smithy.api#documentation": "Detailed information concerning the specification of a CloudFormation extension in a given\n account and Region.
\nFor more information, see Edit configuration data\n for extensions in your account in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#TypeConfigurationDetailsList": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#TypeConfigurationDetails" } }, "com.amazonaws.cloudformation#TypeConfigurationIdentifier": { "type": "structure", "members": { "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { "smithy.api#documentation": "The ARN for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.
" } }, "TypeConfigurationAlias": { "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", "traits": { "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was\n set.
" } }, "TypeConfigurationArn": { "target": "com.amazonaws.cloudformation#TypeConfigurationArn", "traits": { "smithy.api#documentation": "The ARN for the configuration, in this account and Region.
" } }, "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { "smithy.api#documentation": "The type of extension.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "The name of the extension type to which this configuration applies.
" } } }, "traits": { "smithy.api#documentation": "Identifying information for the configuration of a CloudFormation extension.
" } }, "com.amazonaws.cloudformation#TypeConfigurationIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.cloudformation#TypeConfigurationNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage", "traits": { "smithy.api#documentation": "A message with details about the error that occurred.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "TypeConfigurationNotFoundException", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified extension configuration can't be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudformation#TypeFilters": { "type": "structure", "members": { "Category": { "target": "com.amazonaws.cloudformation#Category", "traits": { "smithy.api#documentation": "The category of extensions to return.
\n\n REGISTERED: Private extensions that have been registered for this account and\n Region.
\n ACTIVATED: Public extensions that have been activated for this account and\n Region.
\n THIRD_PARTY: Extensions available for use from publishers other than Amazon.\n This includes:
Private extensions registered in the account.
\nPublic extensions from publishers other than Amazon, whether activated or not.
\n\n AWS_TYPES: Extensions available for use from Amazon.
The id of the publisher of the extension.
\nExtensions published by Amazon aren't assigned a publisher ID. Use the\n AWS_TYPES category to specify a list of types published by Amazon.
A prefix to use as a filter for results.
" } } }, "traits": { "smithy.api#documentation": "Filter criteria to use in determining which extensions to return.
" } }, "com.amazonaws.cloudformation#TypeHierarchy": { "type": "string" }, "com.amazonaws.cloudformation#TypeName": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 204 }, "smithy.api#pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}$" } }, "com.amazonaws.cloudformation#TypeNamePrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 204 }, "smithy.api#pattern": "^([A-Za-z0-9]{2,64}::){0,2}([A-Za-z0-9]{2,64}:?){0,1}$" } }, "com.amazonaws.cloudformation#TypeNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage", "traits": { "smithy.api#documentation": "A message with details about the error that occurred.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "TypeNotFoundException", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified extension doesn't exist in the CloudFormation registry.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudformation#TypeSchema": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16777216 } } }, "com.amazonaws.cloudformation#TypeSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#TypeSummary" } }, "com.amazonaws.cloudformation#TypeSummary": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { "smithy.api#documentation": "The kind of extension.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "The name of the extension.
\nIf you specified a TypeNameAlias when you call the ActivateType API\n operation in your account and Region, CloudFormation considers that alias as the type name.
The ID of the default version of the extension. The default version is used when the\n extension version isn't specified.
\nThis applies only to private extensions you have registered in your account. For public\n extensions, both those provided by Amazon and published by third parties, CloudFormation returns\n null. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { "smithy.api#documentation": "The ARN of the extension.
" } }, "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more\n information, see ActivateType.
\nFor all other extension types, CloudFormation returns null.
The description of the extension.
" } }, "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { "smithy.api#documentation": "The ID of the extension publisher, if the extension is published by a third party.\n Extensions published by Amazon don't return a publisher ID.
" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the type name of\n the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the account and\n Region, not the type name of the public extension. For more information, see Use\n aliases to refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of\n the public extension to be used for CloudFormation operations in this account and Region.
\nHow you specified AutoUpdate when enabling the extension affects whether\n CloudFormation automatically updates the extension in this account and Region when a new version is\n released. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest\n version of the public extension that is available. For any extensions other\n than activated third-party extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether\n CloudFormation automatically updates the extension in this account and Region when a new version is\n released. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.
The service used to verify the publisher identity.
\nFor more information, see Publishing extensions to make\n them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
" } }, "PublisherName": { "target": "com.amazonaws.cloudformation#PublisherName", "traits": { "smithy.api#documentation": "The publisher name, as defined in the public profile for that publisher in the service used\n to verify the publisher identity.
" } }, "IsActivated": { "target": "com.amazonaws.cloudformation#IsActivated", "traits": { "smithy.api#documentation": "Whether the extension is activated for this account and Region.
\nThis applies only to third-party public extensions. Extensions published by Amazon are\n activated by default.
" } } }, "traits": { "smithy.api#documentation": "Contains summary information about the specified CloudFormation extension.
" } }, "com.amazonaws.cloudformation#TypeTestsStatus": { "type": "enum", "members": { "PASSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASSED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "NOT_TESTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_TESTED" } } } }, "com.amazonaws.cloudformation#TypeTestsStatusDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.cloudformation#TypeVersionId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9-]+$" } }, "com.amazonaws.cloudformation#TypeVersionSummaries": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#TypeVersionSummary" } }, "com.amazonaws.cloudformation#TypeVersionSummary": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { "smithy.api#documentation": "The kind of extension.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#documentation": "The name of the extension.
" } }, "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { "smithy.api#documentation": "The ID of a specific version of the extension. The version ID is the value at the end of the\n ARN assigned to the extension version when it's registered.
" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and extensions\n published by Amazon. For public third-party extensions, CloudFormation returns\n null.
The ARN of the extension version.
" } }, "TimeCreated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { "smithy.api#documentation": "When the version was registered.
" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "The description of the extension version.
" } }, "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the version of\n the public extension to be used for CloudFormation operations in this account and Region. For any\n extensions other than activated third-party extensions, CloudFormation returns\n null.
How you specified AutoUpdate when enabling the extension affects whether\n CloudFormation automatically updates the extension in this account and Region when a new version is\n released. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.
Contains summary information about a specific version of a CloudFormation extension.
" } }, "com.amazonaws.cloudformation#UnprocessedTypeConfigurations": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" } }, "com.amazonaws.cloudformation#UpdateGeneratedTemplate": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#UpdateGeneratedTemplateInput" }, "output": { "target": "com.amazonaws.cloudformation#UpdateGeneratedTemplateOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#AlreadyExistsException" }, { "target": "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException" }, { "target": "com.amazonaws.cloudformation#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Updates a generated template. This can be used to change the name, add and remove\n resources, refresh resources, and change the DeletionPolicy and\n UpdateReplacePolicy settings. You can check the status of the update to the\n generated template using the DescribeGeneratedTemplate API action.
The name or Amazon Resource Name (ARN) of a generated template.
", "smithy.api#required": {} } }, "NewGeneratedTemplateName": { "target": "com.amazonaws.cloudformation#GeneratedTemplateName", "traits": { "smithy.api#documentation": "An optional new name to assign to the generated template.
" } }, "AddResources": { "target": "com.amazonaws.cloudformation#ResourceDefinitions", "traits": { "smithy.api#documentation": "An optional list of resources to be added to the generated template.
" } }, "RemoveResources": { "target": "com.amazonaws.cloudformation#JazzLogicalResourceIds", "traits": { "smithy.api#documentation": "A list of logical ids for resources to remove from the generated template.
" } }, "RefreshAllResources": { "target": "com.amazonaws.cloudformation#RefreshAllResources", "traits": { "smithy.api#documentation": "If true, update the resource properties in the generated template with their\n current live state. This feature is useful when the resource properties in your generated a\n template does not reflect the live state of the resource properties. This happens when a user\n update the resource properties after generating a template.
The configuration details of the generated template, including the\n DeletionPolicy and UpdateReplacePolicy.
The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}.\n For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
Updates a stack as specified in the template. After the call completes successfully, the\n stack update starts. You can check the status of the stack through the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate action.
\nFor more information about updating a stack and monitoring the progress of the update, see\n Managing\n Amazon Web Services resources as a single unit with CloudFormation stacks in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#UpdateStackInput": { "type": "structure", "members": { "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or unique stack ID of the stack to update.
", "smithy.api#required": {} } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "Structure that contains the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
The URL of a file that contains the template body. The URL must point to a template that's\n located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must\n start with https://.
Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are\n updating.
\nWhen using templates with the AWS::LanguageExtensions transform, provide the\n template instead of using UsePreviousTemplate to ensure new parameter values and\n Systems Manager parameter updates are applied correctly. For more information, see AWS::LanguageExtensions transform.
Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Structure that contains the temporary overriding stack policy body. You can specify either\n the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL\n parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is associated\n with the stack will be used.
" } }, "StackPolicyDuringUpdateURL": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { "smithy.api#documentation": "Location of a file that contains the temporary overriding stack policy. The URL must point\n to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The\n location for an Amazon S3 bucket must start with https://. URLs from S3 static\n websites are not supported.
You can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is associated\n with the stack will be used.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.
In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually updating the stack. If your stack template contains one or more macros,\n and you choose to update a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include\n and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from the\n template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if\n you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.
\nFor more information, see Perform custom processing\n on CloudFormation templates with template macros.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
Specifies which resource types you can work with, such as AWS::EC2::Instance\n or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack\n update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this\n parameter for CloudFormation-specific condition keys in IAM policies. For more information, see\n Control CloudFormation\n access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the\n stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that is generated from\n your user credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { "smithy.api#documentation": "Structure that contains a new stack policy body. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.
You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you don't specify a stack policy, the current policy\n that is associated with the stack is unchanged.
" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { "smithy.api#documentation": "Location of a file that contains the updated stack policy. The URL must point to a policy\n (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an\n Amazon S3 bucket must start with https://. URLs from S3 static websites are not\n supported.
You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you don't specify a stack policy, the current policy\n that is associated with the stack is unchanged.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation\n associates with the stack. Specify an empty list to remove all notification topics.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to\n supported resources in the stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you\n specify an empty value, CloudFormation removes all associated tags.
" } }, "DisableRollback": { "target": "com.amazonaws.cloudformation#DisableRollback", "traits": { "smithy.api#documentation": "Preserve the state of previously provisioned resources when an operation fails.
\nDefault: False\n
A unique identifier for this UpdateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to update a stack\n with the same name. You might retry UpdateStack requests to ensure that\n CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
The deployment configuration for this stack operation, including the deployment\n mode.
" } }, "DisableValidation": { "target": "com.amazonaws.cloudformation#DisableValidation", "traits": { "smithy.api#documentation": "\n Set to true to disable pre-deployment validations in changeset or stack operations.\n
\n Default: false\n
The input for an UpdateStack action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#UpdateStackInstances": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#UpdateStackInstancesInput" }, "output": { "target": "com.amazonaws.cloudformation#UpdateStackInstancesOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#InvalidOperationException" }, { "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" }, { "target": "com.amazonaws.cloudformation#OperationInProgressException" }, { "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" }, { "target": "com.amazonaws.cloudformation#StackSetNotFoundException" }, { "target": "com.amazonaws.cloudformation#StaleRequestException" } ], "traits": { "smithy.api#documentation": "Updates the parameter values for stack instances for the specified accounts, within the\n specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and\n Region.
\nYou can only update stack instances in Amazon Web Services Regions and accounts where they already\n exist; to create additional stack instances, use CreateStackInstances.
\nDuring StackSet updates, any parameters overridden for a stack instance aren't updated,\n but retain their overridden value.
\nYou can only update the parameter values that are specified in the\n StackSet. To add or delete a parameter itself, use UpdateStackSet\n to update the StackSet template. If you add a parameter to a template, before you can override\n the parameter value specified in the StackSet you must first use UpdateStackSet\n to update all stack instances with the updated template and parameter value specified in the\n StackSet. Once a stack instance has been updated with the new parameter, you can then override\n the parameter value using UpdateStackInstances.
The maximum number of organizational unit (OUs) supported by a\n UpdateStackInstances operation is 50.
If you need more than 50, consider the following options:
\n\n Batch processing: If you don't want to expose your OU\n hierarchy, split up the operations into multiple calls with less than 50 OUs\n each.
\n\n Parent OU strategy: If you don't mind exposing the OU\n hierarchy, target a parent OU that contains all desired child OUs.
\nThe name or unique ID of the StackSet associated with the stack instances.
", "smithy.api#required": {} } }, "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { "smithy.api#documentation": "[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts in which you want\n to update parameter values for stack instances. The overridden parameter values will be\n applied to all stack instances in the specified accounts and Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
[Service-managed permissions] The Organizations accounts in which you want to\n update parameter values for stack instances. If your update targets OUs, the overridden\n parameter values only apply to the accounts that are currently in the target OUs and their\n child OUs. Accounts added to the target OUs and their child OUs in the future won't use the\n overridden values.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
The names of one or more Amazon Web Services Regions in which you want to update parameter values for\n stack instances. The overridden parameter values will be applied to all stack instances in the\n specified accounts and Amazon Web Services Regions.
", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { "smithy.api#documentation": "A list of input parameters whose values you want to update for the specified stack\n instances.
\nAny overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify its\n value.
\nTo leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the StackSet, specify a\n parameter list but don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at\n all.
\nDuring StackSet updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.
\nYou can only override the parameter values that are specified in the\n StackSet. To add or delete a parameter itself, use UpdateStackSet to update the\n StackSet template. If you add a parameter to a template, before you can override the parameter\n value specified in the StackSet you must first use UpdateStackSet\n to update all stack instances with the updated template and parameter value specified in the\n StackSet. Once a stack instance has been updated with the new parameter, you can then override\n the parameter value using UpdateStackInstances.
Preferences for how CloudFormation performs this StackSet operation.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique identifier for this StackSet operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the StackSet operation only once, even if you retry the request multiple times. You\n might retry StackSet operation requests to ensure that CloudFormation successfully received\n them.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nThe unique identifier for this StackSet operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#UpdateStackOutput": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "Unique identifier of the stack.
" } }, "OperationId": { "target": "com.amazonaws.cloudformation#OperationId", "traits": { "smithy.api#documentation": "A unique identifier for this update operation that can be used to track the operation's\n progress and events.
" } } }, "traits": { "smithy.api#documentation": "The output for an UpdateStack action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#UpdateStackSet": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#UpdateStackSetInput" }, "output": { "target": "com.amazonaws.cloudformation#UpdateStackSetOutput" }, "errors": [ { "target": "com.amazonaws.cloudformation#InvalidOperationException" }, { "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" }, { "target": "com.amazonaws.cloudformation#OperationInProgressException" }, { "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" }, { "target": "com.amazonaws.cloudformation#StackSetNotFoundException" }, { "target": "com.amazonaws.cloudformation#StaleRequestException" } ], "traits": { "smithy.api#documentation": "Updates the StackSet and associated stack instances in the specified accounts and\n Amazon Web Services Regions.
\nEven if the StackSet operation created by updating the StackSet fails (completely or\n partially, below or above a specified failure tolerance), the StackSet is updated with your\n changes. Subsequent CreateStackInstances calls on the specified StackSet use\n the updated StackSet.
\nThe maximum number of organizational unit (OUs) supported by a\n UpdateStackSet operation is 50.
If you need more than 50, consider the following options:
\n\n Batch processing: If you don't want to expose your OU\n hierarchy, split up the operations into multiple calls with less than 50 OUs\n each.
\n\n Parent OU strategy: If you don't mind exposing the OU\n hierarchy, target a parent OU that contains all desired child OUs.
\nThe name or unique ID of the StackSet that you want to update.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "A brief description of updates that you are making.
" } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes.
\nConditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL\u2014or set\n UsePreviousTemplate to true.
The URL of a file that contains the template body. The URL must point to a template\n (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The\n location for an Amazon S3 bucket must start with https://. S3 static website URLs are\n not supported.
Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL\u2014or set\n UsePreviousTemplate to true.
Use the existing template that's associated with the StackSet that you're updating.
\nConditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL\u2014or set\n UsePreviousTemplate to true.
A list of input parameters for the StackSet template.
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the StackSet and its associated stack\n instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n AWS::IAM::AccessKey\n
\n\n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n AWS::IAM::Role\n
\n\n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your StackSet template references one or more\n macros, you must update the StackSet directly from the processed template, without first\n reviewing the resulting changes in a change set. To update the StackSet directly, you must\n acknowledge this capability. For more information, see Perform custom processing\n on CloudFormation templates with template macros.
\nWith service-managed permissions, CloudFormation can process macros, nested stacks, and\n transforms in your StackSet template only when you provide a custom execution role\n template. (Macros include the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) The\n default service-managed execution role can't provision them: if you reference a macro\n in your template, the StackSet operation fails even when you specify this\n capability.
\nTo use macros, nested stacks, or transforms with service-managed permissions,\n specify a custom execution role template in\n ExecutionRoleTemplateBody or ExecutionRoleTemplateUrl, and\n specify both CAPABILITY_NAMED_IAM and\n CAPABILITY_AUTO_EXPAND.
The key-value pairs to associate with this StackSet and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks.\n You can specify a maximum number of 50 tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this StackSet. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's\n tags.
\nIf you specify any tags using this parameter, you must specify\n all the tags that you want associated with this StackSet, even tags\n you've specified before (for example, when creating the StackSet or during a previous\n update of the StackSet.). Any tags that you don't include in the updated list of tags are\n removed from the StackSet, and therefore from the stacks and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently associated\n tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation\n checks to see if you have the required IAM permission to tag resources. If you omit tags\n that are currently associated with the StackSet from the list of tags you specify, CloudFormation\n assumes that you want to remove those tags from the StackSet, and checks to see if you have\n permission to untag resources. If you don't have the necessary permission(s), the entire\n UpdateStackSet action fails with an access denied error, and the\n StackSet is not updated.
Preferences for how CloudFormation performs this StackSet operation.
" } }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { "smithy.api#documentation": "[Self-managed permissions] The Amazon Resource Name (ARN) of the IAM role to use to\n update this StackSet.
\nSpecify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific StackSets within the same administrator account. For\n more information, see Grant\n self-managed permissions in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the StackSet, you must\n specify a customized administrator role, even if it is the same customized administrator role\n used with this StackSet previously.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { "smithy.api#documentation": "The name of the IAM execution role that CloudFormation uses for StackSet operations in your\n target accounts.
\n[Self-managed permissions] The name of the IAM execution role to use to update the stack\n set. If you do not specify an execution role, CloudFormation uses the\n AWSCloudFormationStackSetExecutionRole role for the StackSet operation. Specify\n an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their StackSets.
If you specify a customized execution role, CloudFormation uses that role to update the stack.\n If you do not specify a customized execution role, CloudFormation performs the update using the\n role previously associated with the StackSet, so long as you have permissions to perform\n operations on the StackSet.
\n[Service-managed permissions] Set this name when you use custom execution roles. The role\n that your custom execution role template provisions in your target accounts must have this\n same name, and the name must begin with\n stacksets-exec-custom-. You don't need to specify this parameter if an\n execution role name is already configured for the StackSet and you aren't changing it.
[Service-managed permissions] The Organizations accounts in which to update\n associated stack instances.
\nTo update all the stack instances associated with this StackSet, do not specify\n DeploymentTargets or Regions.
If the StackSet update includes changes to the template (that is, if\n TemplateBody or TemplateURL is specified), or the\n Parameters, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the StackSet update doesn't include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.
Describes how the IAM roles required for StackSet operations are created. You cannot\n modify PermissionModel if there are stack instances associated with your stack\n set.
With self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n self-managed permissions.
With service-managed permissions, StackSets automatically creates the\n IAM roles required to deploy to accounts managed by Organizations. For more\n information, see Activate trusted access for StackSets with Organizations.
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).\n For more information, see Enable or disable automatic deployments for StackSets in Organizations\n in the CloudFormation User Guide.
\nIf you specify AutoDeployment, don't specify DeploymentTargets\n or Regions.
The unique ID for this StackSet operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the StackSet operation only once, even if you retry the request multiple times. You\n might retry StackSet operation requests to ensure that CloudFormation successfully received\n them.
\nIf you don't specify an operation ID, CloudFormation generates one\n automatically.
\nRepeating this StackSet operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
[Self-managed permissions] The accounts in which to update associated stack instances. If\n you specify accounts, you must also specify the Amazon Web Services Regions in which to update StackSet\n instances.
\nTo update all the stack instances associated with this StackSet,\n don't specify the Accounts or Regions properties.
If the StackSet update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the StackSet update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while\n leaving all other stack instances with their existing stack instance status.
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions,\n you must also specify accounts in which to update StackSet instances.
\nTo update all the stack instances associated with this StackSet, do\n not specify the Accounts or Regions properties.
If the StackSet update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the StackSet update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nDescribes whether CloudFormation performs non-conflicting operations concurrently and queues\n conflicting operations.
" } }, "ExecutionRoleTemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "The body of the template that creates or updates a custom execution role in target accounts. This parameter applies only when the permissions model is SERVICE_MANAGED.
Conditional: Specify either ExecutionRoleTemplateBody or\n ExecutionRoleTemplateUrl, but not both. If you don't specify either, CloudFormation\n uses the default service-managed execution role in target accounts.
The URL of an Amazon S3 object that contains the template that creates or updates a custom execution role in target accounts. This parameter applies only when the permissions model is SERVICE_MANAGED.
Conditional: Specify either ExecutionRoleTemplateBody or\n ExecutionRoleTemplateUrl, but not both. If you don't specify either, CloudFormation\n uses the default service-managed execution role in target accounts.
Specifies whether CloudFormation uses the default service-managed execution role instead of a custom execution role in target accounts.\n If you set this to true, CloudFormation ignores any custom execution role template specified in ExecutionRoleTemplateBody or ExecutionRoleTemplateUrl.
The name of the Amazon S3 bucket that stores the execution role stack template body. CloudFormation uses this bucket only when you specify a custom execution role template.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#UpdateStackSetOutput": { "type": "structure", "members": { "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique ID for this StackSet operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#UpdateTerminationProtection": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionInput" }, "output": { "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput" }, "traits": { "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete a\n stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protect a CloudFormation\n stack from being deleted in the CloudFormation User Guide.
\nFor nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" } }, "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { "type": "structure", "members": { "EnableTerminationProtection": { "target": "com.amazonaws.cloudformation#EnableTerminationProtection", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Whether to enable termination protection on the specified stack.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or unique ID of the stack for which you want to set termination\n protection.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput": { "type": "structure", "members": { "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { "smithy.api#documentation": "The unique ID of the stack.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudformation#Url": { "type": "string" }, "com.amazonaws.cloudformation#UseAdminExecutionRoleNullable": { "type": "boolean" }, "com.amazonaws.cloudformation#UsePreviousTemplate": { "type": "boolean" }, "com.amazonaws.cloudformation#UsePreviousValue": { "type": "boolean" }, "com.amazonaws.cloudformation#ValidateTemplate": { "type": "operation", "input": { "target": "com.amazonaws.cloudformation#ValidateTemplateInput" }, "output": { "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" }, "traits": { "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If\n it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail,\n CloudFormation returns a template validation error.
" } }, "com.amazonaws.cloudformation#ValidateTemplateInput": { "type": "structure", "members": { "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "Structure that contains the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.
The URL of a file that contains the template body. The URL must point to a template (max\n size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for\n an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.
The input for ValidateTemplate action.
", "smithy.api#input": {} } }, "com.amazonaws.cloudformation#ValidateTemplateOutput": { "type": "structure", "members": { "Parameters": { "target": "com.amazonaws.cloudformation#TemplateParameters", "traits": { "smithy.api#documentation": "A list of TemplateParameter structures.
The description found within the template.
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you\n must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template;\n otherwise, those actions return an InsufficientCapabilities error.
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
" } }, "CapabilitiesReason": { "target": "com.amazonaws.cloudformation#CapabilitiesReason", "traits": { "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response\n element.
A list of the transforms that are declared in the template.
" } } }, "traits": { "smithy.api#documentation": "The output for ValidateTemplate action.
", "smithy.api#output": {} } }, "com.amazonaws.cloudformation#ValidationName": { "type": "string" }, "com.amazonaws.cloudformation#ValidationPath": { "type": "string" }, "com.amazonaws.cloudformation#ValidationStatus": { "type": "enum", "members": { "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "SKIPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIPPED" } } } }, "com.amazonaws.cloudformation#ValidationStatusReason": { "type": "string" }, "com.amazonaws.cloudformation#Value": { "type": "string" }, "com.amazonaws.cloudformation#Version": { "type": "string" }, "com.amazonaws.cloudformation#VersionBump": { "type": "enum", "members": { "MAJOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAJOR" } }, "MINOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MINOR" } } } }, "com.amazonaws.cloudformation#Visibility": { "type": "enum", "members": { "PUBLIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUBLIC" } }, "PRIVATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIVATE" } } } }, "com.amazonaws.cloudformation#WarningDetail": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudformation#WarningType", "traits": { "smithy.api#documentation": "The type of this warning. For more information, see Resolve\n write-only properties in the CloudFormation User Guide.
\n\n MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive\n write-only properties. The IaC generator selects one set of mutually exclusive properties and\n converts the included properties into parameters. The parameter names have a suffix\n OneOf and the parameter descriptions indicate that the corresponding property can\n be replaced with other exclusive properties.
\n UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource.\n One example of unsupported properties would be a required write-only property that is an array,\n because a parameter cannot be an array. Another example is an optional write-only\n property.
\n MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are\n found in the resource, and the type of that property can be any of several types.
Currently the resource and property reference documentation does not indicate if a property\n uses a type of oneOf or anyOf. You need to look at the resource\n provider schema.
The properties of the resource that are impacted by this warning.
" } } }, "traits": { "smithy.api#documentation": "The warnings generated for a specific resource for this generated template.
" } }, "com.amazonaws.cloudformation#WarningDetails": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#WarningDetail" } }, "com.amazonaws.cloudformation#WarningProperties": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#WarningProperty" } }, "com.amazonaws.cloudformation#WarningProperty": { "type": "structure", "members": { "PropertyPath": { "target": "com.amazonaws.cloudformation#PropertyPath", "traits": { "smithy.api#documentation": "The path of the property. For example, if this is for the S3Bucket member of\n the Code property, the property path would be Code/S3Bucket.
If true, the specified property is required.
The description of the property from the resource provider schema.
" } } }, "traits": { "smithy.api#documentation": "A specific property that is impacted by a warning.
" } }, "com.amazonaws.cloudformation#WarningType": { "type": "enum", "members": { "MUTUALLY_EXCLUSIVE_PROPERTIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MUTUALLY_EXCLUSIVE_PROPERTIES" } }, "UNSUPPORTED_PROPERTIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_PROPERTIES" } }, "MUTUALLY_EXCLUSIVE_TYPES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MUTUALLY_EXCLUSIVE_TYPES" } }, "EXCLUDED_PROPERTIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXCLUDED_PROPERTIES" } }, "EXCLUDED_RESOURCES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXCLUDED_RESOURCES" } } } }, "com.amazonaws.cloudformation#Warnings": { "type": "structure", "members": { "UnrecognizedResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { "smithy.api#documentation": "A list of all of the unrecognized resource types. This is only returned if the\n TemplateSummaryConfig parameter has the\n TreatUnrecognizedResourceTypesAsWarning configuration set to\n True.
Contains any warnings returned by the GetTemplateSummary API action.