diff --git a/Cargo.toml b/Cargo.toml index b60630d678e8..84dcde4be3cc 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,12 +1,12 @@ [workspace] exclude = [ - "examples/lambda", - "examples/test-utils", "examples/examples", "examples/webassembly", + "examples/lambda", + "examples/test-utils", "examples/cross_service", - "tests/webassembly", - "tests/no-default-features" + "tests/no-default-features", + "tests/webassembly" ] members = [ "sdk/accessanalyzer", diff --git a/aws-models/cloudformation.json b/aws-models/cloudformation.json index 3f93316e0cec..09d2c3711b6e 100644 --- a/aws-models/cloudformation.json +++ b/aws-models/cloudformation.json @@ -1084,6 +1084,9 @@ { "target": "com.amazonaws.cloudformation#CreateChangeSet" }, + { + "target": "com.amazonaws.cloudformation#CreateGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#CreateStack" }, @@ -1102,6 +1105,9 @@ { "target": "com.amazonaws.cloudformation#DeleteChangeSet" }, + { + "target": "com.amazonaws.cloudformation#DeleteGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#DeleteStack" }, @@ -1123,12 +1129,18 @@ { "target": "com.amazonaws.cloudformation#DescribeChangeSetHooks" }, + { + "target": "com.amazonaws.cloudformation#DescribeGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#DescribeOrganizationsAccess" }, { "target": "com.amazonaws.cloudformation#DescribePublisher" }, + { + "target": "com.amazonaws.cloudformation#DescribeResourceScan" + }, { "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus" }, @@ -1177,6 +1189,9 @@ { "target": "com.amazonaws.cloudformation#ExecuteChangeSet" }, + { + "target": "com.amazonaws.cloudformation#GetGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#GetStackPolicy" }, @@ -1195,9 +1210,21 @@ { "target": "com.amazonaws.cloudformation#ListExports" }, + { + "target": "com.amazonaws.cloudformation#ListGeneratedTemplates" + }, { "target": "com.amazonaws.cloudformation#ListImports" }, + { + "target": "com.amazonaws.cloudformation#ListResourceScanRelatedResources" + }, + { + "target": "com.amazonaws.cloudformation#ListResourceScanResources" + }, + { + "target": "com.amazonaws.cloudformation#ListResourceScans" + }, { "target": "com.amazonaws.cloudformation#ListStackInstanceResourceDrifts" }, @@ -1255,12 +1282,18 @@ { "target": "com.amazonaws.cloudformation#SignalResource" }, + { + "target": "com.amazonaws.cloudformation#StartResourceScan" + }, { "target": "com.amazonaws.cloudformation#StopStackSetOperation" }, { "target": "com.amazonaws.cloudformation#TestType" }, + { + "target": "com.amazonaws.cloudformation#UpdateGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#UpdateStack" }, @@ -2330,6 +2363,23 @@ } } }, + "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.
Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of\n the template generation using the DescribeGeneratedTemplate
API action.
An optional list of resources to be included in the generated template.
\n If no resources are specified,the template will be created without any resources. Resources can be added to the\n template using the UpdateGeneratedTemplate
API 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 template.
" + } + }, + "TemplateConfiguration": { + "target": "com.amazonaws.cloudformation#TemplateConfiguration", + "traits": { + "smithy.api#documentation": "The configuration details of the generated template, including the DeletionPolicy
and\n UpdateReplacePolicy
.
The ID of the generated template.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudformation#CreateStack": { "type": "operation", "input": { @@ -2651,7 +2798,7 @@ "TimeoutInMinutes": { "target": "com.amazonaws.cloudformation#TimeoutMinutes", "traits": { - "smithy.api#documentation": "The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
\n is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if\n DisableRollback
is not set or is set to false
, the stack will be rolled back.
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": { @@ -3833,6 +4025,113 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudformation#DescribeGeneratedTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeGeneratedTemplateInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeGeneratedTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a generated template. The output includes details about the progress of the creation of a generated\n template started by a CreateGeneratedTemplate
API action or the update of a generated template started\n with an UpdateGeneratedTemplate
API 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}
. 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 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 failure\n 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 template.
" + } + }, + "TemplateConfiguration": { + "target": "com.amazonaws.cloudformation#TemplateConfiguration", + "traits": { + "smithy.api#documentation": "The configuration details of the generated template, including the DeletionPolicy
and\n UpdateReplacePolicy
.
The number of warnings generated for this template. The warnings are found in the details of each of the\n resources in the template.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudformation#DescribeOrganizationsAccess": { "type": "operation", "input": { @@ -3945,26 +4244,31 @@ "smithy.api#output": {} } }, - "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus": { + "com.amazonaws.cloudformation#DescribeResourceScan": { "type": "operation", "input": { - "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput" + "target": "com.amazonaws.cloudformation#DescribeResourceScanInput" }, "output": { - "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput" + "target": "com.amazonaws.cloudformation#DescribeResourceScanOutput" }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ResourceScanNotFoundException" + } + ], "traits": { - "smithy.api#documentation": "Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift
returns a StackDriftDetectionId
you can use to monitor the progress of\n the operation using DescribeStackDriftDetectionStatus
. Once the drift detection operation has completed,\n use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.
Describes details of a resource scan.
" } }, - "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput": { + "com.amazonaws.cloudformation#DescribeResourceScanInput": { "type": "structure", "members": { - "StackDriftDetectionId": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionId", + "ResourceScanId": { + "target": "com.amazonaws.cloudformation#ResourceScanId", "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 is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource scan.
", "smithy.api#required": {} } } @@ -3973,57 +4277,61 @@ "smithy.api#input": {} } }, - "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput": { + "com.amazonaws.cloudformation#DescribeResourceScanOutput": { "type": "structure", "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", + "ResourceScanId": { + "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the stack.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}
. An example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n
.
The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of reports CloudFormation retains for any given stack, and for how long, may vary.
", - "smithy.api#required": {} + "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.
\nStatus of the stack's actual configuration compared to its expected configuration.
\n\n DRIFTED
: The stack differs from its expected template configuration. A stack is considered to\n 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 template\n configuration.
\n IN_SYNC
: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN
: This value is reserved for future use.
The reason for the resource scan status, providing more information if a failure happened.
" } }, - "DetectionStatus": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionStatus", + "StartTime": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE
: The stack drift detection operation has successfully completed for all\n resources in the stack that support drift detection. (Resources that don't currently support stack detection remain\n unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation,\n only the resources with those logical IDs are checked for drift.
\n\n DETECTION_FAILED
: The stack drift detection operation has failed for at least one resource in the\n stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS
: The stack drift detection operation is currently in progress.
The time that the resource scan was started.
" } }, - "DetectionStatusReason": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionStatusReason", + "EndTime": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "The reason the stack drift detection operation has its current status.
" + "smithy.api#documentation": "The time that the resource scan was finished.
" } }, - "DriftedStackResourceCount": { - "target": "com.amazonaws.cloudformation#BoxedInteger", + "PercentageCompleted": { + "target": "com.amazonaws.cloudformation#PercentageCompleted", "traits": { - "smithy.api#documentation": "Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a\n status of DETECTION_COMPLETE
. This value will be 0 for stacks whose drift status is\n IN_SYNC
.
The percentage of the resource scan that has been completed.
" } }, - "Timestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", + "ResourceTypes": { + "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Time at which the stack drift detection operation was initiated.
", - "smithy.api#required": {} + "smithy.api#documentation": "The list of resource types for the specified scan. Resource types are only available for scans with a\n Status
set to COMPLETE
or FAILED
.
The number of resources that were listed. This is only available for scans with a Status
set to\n COMPLETE
, EXPIRED
, or FAILED
.
The number of resources that were read. This is only available for scans with a Status
set to\n COMPLETE
, EXPIRED
, or FAILED
.
This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException
.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift
returns a StackDriftDetectionId
you can use to monitor the progress of\n the operation using DescribeStackDriftDetectionStatus
. Once the drift detection operation has completed,\n 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 is run. However, the number\n of drift results CloudFormation retains for any given stack, and for 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 is run. However, the number\n of reports CloudFormation retains for any given stack, and for how 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 stack is considered to\n 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 template\n configuration.
\n IN_SYNC
: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN
: This value is reserved for future use.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE
: The stack drift detection operation has successfully completed for all\n resources in the stack that support drift detection. (Resources that don't currently support stack detection remain\n unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation,\n only the resources with those logical IDs are checked for drift.
\n\n DETECTION_FAILED
: The stack drift detection operation has failed for at least one resource in the\n stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS
: The stack drift detection operation is currently 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 operation reaches a\n status of DETECTION_COMPLETE
. This value will be 0 for stacks whose drift status is\n 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 more information\n about a stack's event history, go to Stacks in the\n CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by specifying the unique stack\n identifier (stack ID).
\nReturns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is\n returned.
" - } - }, - "com.amazonaws.cloudformation#GetStackPolicyInput": { - "type": "structure", + "com.amazonaws.cloudformation#GeneratedTemplateDeletionPolicy": { + "type": "enum", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "DELETE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or unique stack ID that's associated with the stack whose policy you want to get.
", - "smithy.api#required": {} + "smithy.api#enumValue": "DELETE" + } + }, + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" } } - }, - "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 containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)
" - } + "com.amazonaws.cloudformation#GeneratedTemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 } - }, + } + }, + "com.amazonaws.cloudformation#GeneratedTemplateName": { + "type": "string", "traits": { - "smithy.api#documentation": "The output for the GetStackPolicy action.
", - "smithy.api#output": {} + "smithy.api#length": { + "min": 1, + "max": 128 + } } }, - "com.amazonaws.cloudformation#GetTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#GetTemplateInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#GetTemplateOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" + "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" } - ], + }, "traits": { - "smithy.api#documentation": "Returns the template body for a specified stack. You can get the template for running or deleted stacks.
\nFor deleted stacks, GetTemplate
returns the template for up to 90 days after the stack has been\n deleted.
If the template doesn't exist, a ValidationError
is returned.
The generated template was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 } }, - "com.amazonaws.cloudformation#GetTemplateInput": { - "type": "structure", + "com.amazonaws.cloudformation#GeneratedTemplateResourceStatus": { + "type": "enum", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "PENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack, which aren't always 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.
\nDefault: There is no default value.
" + "smithy.api#enumValue": "PENDING" } }, - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", + "IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated\n template. If you specify a name, you must also specify the StackName
.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original
. To get the template after CloudFormation has\n processed all transforms, specify Processed
.
If the template doesn't include transforms, Original
and Processed
return the same\n template. By default, CloudFormation specifies Processed
.
The input for a GetTemplate action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#GetTemplateOutput": { - "type": "structure", - "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nCloudFormation returns the same template that was used when the stack was created.
" + "smithy.api#enumValue": "FAILED" } }, - "StagesAvailable": { - "target": "com.amazonaws.cloudformation#StageList", + "COMPLETE": { + "target": "smithy.api#Unit", "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 Original
template is always\n available. After CloudFormation finishes creating the change set, the Processed
template becomes\n 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
action is useful for\n viewing parameter information, such as default parameter values and parameter types, before you create or update a\n stack or stack set.
You can use the GetTemplateSummary
action when you submit a template, or you can get template\n information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary
returns the template information for up to 90 days after the\n stack has been deleted. If the template doesn't exist, a ValidationError
is returned.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName
,\n StackSetName
, TemplateBody
, or TemplateURL
.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName
,\n StackSetName
, TemplateBody
, or TemplateURL
.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName
,\n StackSetName
, TemplateBody
, or TemplateURL
.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName
,\n StackSetName
, TemplateBody
, or TemplateURL
.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF
is specified. Use SELF
for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF
.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN
.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nRetrieves a generated template. If the template is in an InProgress
or Pending
status\n then the template returned will be the template when the template was last in a Complete
status. If the\n template has not yet been in a 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}
. 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 Language
\n parameter.
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is\n 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 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 containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the 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 deleted stacks.
\nFor deleted stacks, GetTemplate
returns the template for up to 90 days after the stack has been\n 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 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.
\nDefault: There is no default value.
" + } + }, + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated\n template. If you specify a name, you must also specify the StackName
.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original
. To get the template after CloudFormation has\n processed all transforms, specify Processed
.
If the template doesn't include transforms, Original
and Processed
return the same\n template. By default, CloudFormation specifies 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 containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\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 Original
template is always\n available. After CloudFormation finishes creating the change set, the Processed
template becomes\n 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
action is useful for\n viewing parameter information, such as default parameter values and parameter types, before you create or update a\n stack or stack set.
You can use the GetTemplateSummary
action when you submit a template, or you can get template\n information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary
returns the template information for up to 90 days after the\n stack has been deleted. If the template doesn't exist, a ValidationError
is returned.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName
,\n StackSetName
, TemplateBody
, or TemplateURL
.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName
,\n StackSetName
, TemplateBody
, or TemplateURL
.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName
,\n StackSetName
, TemplateBody
, or TemplateURL
.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName
,\n StackSetName
, TemplateBody
, or TemplateURL
.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF
is specified. Use SELF
for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF
.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN
.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe 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 + "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 lists change\n sets that are in the CREATE_IN_PROGRESS
or CREATE_PENDING
state.
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string (provided by the ListChangeSets response output) that identifies the next page of\n change sets that you want to retrieve.
" + } + } + }, + "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 change set for the\n specified stack.
If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional\n 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. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see \n CloudFormation export stack output values.
", + "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": "A string (provided by the ListExports response output) that identifies the next page of\n exported output values that you asked to retrieve.
" + } + } + }, + "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 of exports. If there is\n 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": "A string that identifies the next page of resource scan results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudformation#MaxResults", + "traits": { + "smithy.api#documentation": " If the number of available results exceeds this maximum, the response includes a NextToken
value\n that you can use for the NextToken
parameter to get the next set of results. By default the\n ListGeneratedTemplates
API action will return at most 50 results in each response. The maximum value is\n 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 a token. To retrieve\n the next set of results, call ListGeneratedTemplates
again and use that value for the\n NextToken
parameter. If the request returns all results, NextToken
is set to an empty\n string.
Lists all stacks that are importing an exported output value. To modify or remove an exported output value,\n first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
\nFor more information about importing an exported output value, see the Fn::ImportValue\n 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 importing this\n value.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string (provided by the ListImports response output) that identifies the next page of stacks\n that are importing the specified exported output value.
" + } + } + }, + "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 value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cloudformation#LimitName": { - "type": "string" - }, - "com.amazonaws.cloudformation#LimitValue": { - "type": "integer" - }, - "com.amazonaws.cloudformation#ListChangeSets": { + "com.amazonaws.cloudformation#ListResourceScanRelatedResources": { "type": "operation", "input": { - "target": "com.amazonaws.cloudformation#ListChangeSetsInput" + "target": "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesInput" }, "output": { - "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" + "target": "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesOutput" }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ResourceScanInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#ResourceScanNotFoundException" + } + ], "traits": { - "smithy.api#documentation": "Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change\n sets that are in the CREATE_IN_PROGRESS
or CREATE_PENDING
state.
Lists the related resources for a list of resources from a resource scan. The response indicates whether each\n 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": "Summaries" + "items": "RelatedResources", + "pageSize": "MaxResults" } } }, - "com.amazonaws.cloudformation#ListChangeSetsInput": { + "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesInput": { "type": "structure", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", + "ResourceScanId": { + "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
", + "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 can be\n provided.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string (provided by the ListChangeSets response output) that identifies the next page of\n change sets that you want to retrieve.
" + "smithy.api#documentation": "A string that identifies the next page of resource scan results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudformation#BoxedMaxResults", + "traits": { + "smithy.api#documentation": " If the number of available results exceeds this maximum, the response includes a NextToken
value\n that you can use for the NextToken
parameter to get the next set of results. By default the\n ListResourceScanRelatedResources
API action will return up to 100 results in each response. The maximum\n value is 100.
The input for the ListChangeSets action.
", "smithy.api#input": {} } }, - "com.amazonaws.cloudformation#ListChangeSetsOutput": { + "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesOutput": { "type": "structure", "members": { - "Summaries": { - "target": "com.amazonaws.cloudformation#ChangeSetSummaries", + "RelatedResources": { + "target": "com.amazonaws.cloudformation#RelatedResources", "traits": { - "smithy.api#documentation": "A list of ChangeSetSummary
structures that provides the ID and status of each change set for the\n specified stack.
List of up to MaxResults
resources in the specified resource scan related to the specified\n resources.
If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional\n page, this value is null
.
If the request doesn't return all the remaining results, NextToken
is set to a token. To retrieve\n the next set of results, call ListResourceScanRelatedResources
again and use that value for the\n NextToken
parameter. If the request returns all results, NextToken
is set to an empty\n string.
The output for the ListChangeSets action.
", "smithy.api#output": {} } }, - "com.amazonaws.cloudformation#ListExports": { + "com.amazonaws.cloudformation#ListResourceScanResources": { "type": "operation", "input": { - "target": "com.amazonaws.cloudformation#ListExportsInput" + "target": "com.amazonaws.cloudformation#ListResourceScanResourcesInput" }, "output": { - "target": "com.amazonaws.cloudformation#ListExportsOutput" + "target": "com.amazonaws.cloudformation#ListResourceScanResourcesOutput" }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ResourceScanInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#ResourceScanNotFoundException" + } + ], "traits": { - "smithy.api#documentation": "Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see \n CloudFormation export stack output values.
", + "smithy.api#documentation": "Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type\n prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates\n whether each returned resource is 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": "Exports" + "items": "Resources", + "pageSize": "MaxResults" } } }, - "com.amazonaws.cloudformation#ListExportsInput": { + "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 of them in the case\n 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 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": "A string (provided by the ListExports response output) that identifies the next page of\n exported output values that you asked to retrieve.
" + "smithy.api#documentation": "A string that identifies the next page of resource scan results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", + "traits": { + "smithy.api#documentation": " If the number of available results exceeds this maximum, the response includes a NextToken
value\n that you can use for the NextToken
parameter to get the next set of results. By default the\n ListResourceScanResources
API action will return at most 100 results in each response. The maximum value\n is 100.
The output for the ListExports action.
" + "smithy.api#documentation": "List of up to MaxResults
resources in the specified resource scan that match all of the specified\n filters.
If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is\n no additional page, this value is null.
" + "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken
is set to a token. To retrieve\n the next set of results, call ListResourceScanResources
again and use that value for the\n NextToken
parameter. If the request returns all results, NextToken
is set to an empty\n string.
Lists all stacks that are importing an exported output value. To modify or remove an exported output value,\n first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
\nFor more information about importing an exported output value, see the Fn::ImportValue\n function.
", + "smithy.api#documentation": "List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Imports" + "items": "ResourceScanSummaries", + "pageSize": "MaxResults" } } }, - "com.amazonaws.cloudformation#ListImportsInput": { + "com.amazonaws.cloudformation#ListResourceScansInput": { "type": "structure", "members": { - "ExportName": { - "target": "com.amazonaws.cloudformation#ExportName", + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are importing this\n value.
", - "smithy.api#required": {} + "smithy.api#documentation": "A string that identifies the next page of resource scan results.
" } }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", + "MaxResults": { + "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", "traits": { - "smithy.api#documentation": "A string (provided by the ListImports response output) that identifies the next page of stacks\n that are importing the specified exported output value.
" + "smithy.api#documentation": " If the number of available results exceeds this maximum, the response includes a NextToken
value\n that you can use for the NextToken
parameter to get the next set of results. The default value is 10.\n The maximum value is 100.
A list of stack names that are importing the specified exported output value.
" + "smithy.api#documentation": "The list of scans returned.
" } }, "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 value is null.
" + "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken
is set to a token. To retrieve\n the next set of results, call ListResourceScans
again and use that value for the NextToken
\n parameter. If the request returns all results, NextToken
is set to an empty string.
Indicates whether CloudFormation can determine the target value, and whether the target value will change\n before you execute a change set.
\nFor Static
evaluations, CloudFormation can determine that the target value will change, and its\n value. For example, if you directly modify the InstanceType
property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static
\n evaluation.
For Dynamic
evaluations, can't determine the target value because it depends on the result of an\n intrinsic function, such as a Ref
or Fn::GetAtt
intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.
The group to which the CausingEntity
value belongs. There are five entity groups:
\n ResourceReference
entities are Ref
intrinsic functions that refer to resources in the\n template, such as { \"Ref\" : \"MyEC2InstanceResource\" }
.
\n ParameterReference
entities are Ref
intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }
.
\n ResourceAttribute
entities are Fn::GetAtt
intrinsic functions that get resource attribute\n values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }
.
\n DirectModification
entities are changes that are made directly to the template.
\n Automatic
entities are AWS::CloudFormation::Stack
resource types, which are also known as\n nested stacks. If you made no changes to the AWS::CloudFormation::Stack
resource, CloudFormation\n sets the ChangeSource
to Automatic
because the nested stack's template might have\n changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the\n parent stack.
The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource
field. For example, if you modified the value of the KeyPairName
\n parameter, the CausingEntity
is the name of the parameter (KeyPairName
).
If the ChangeSource
value is DirectModification
, no value is given for\n CausingEntity
.
For a resource with Modify
as the action, the ResourceChange
structure describes the\n changes CloudFormation will make to that resource.
The type of the resource, such as AWS::DynamoDB::Table
. For the list of supported resources, see\n IaC\n generator supported resource types in the 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 name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier
list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table
resource, the primary identifiers is TableName
so the key-value pair\n could be \"TableName\": \"MyDDBTable\"
. For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.
A resource included in a generated template. This data type is used with the\n CreateGeneratedTemplate
and UpdateGeneratedTemplate
API actions.
The type of the resource, such as AWS::DynamoDB::Table
. For the list of supported resources, see\n IaC\n generator supported resource types In the 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. The key is the name\n of one of the primary identifiers for the resource. (Primary identifiers are specified in the\n primaryIdentifier
list in the resource schema.) The value is the value of that primary identifier. For\n example, for a AWS::DynamoDB::Table
resource, the primary identifiers is TableName
so the\n key-value pair could be \"TableName\": \"MyDDBTable\"
. For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.
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 group to which the CausingEntity
value belongs. There are five entity groups:
\n ResourceReference
entities are Ref
intrinsic functions that refer to resources in the\n template, such as { \"Ref\" : \"MyEC2InstanceResource\" }
.
\n ParameterReference
entities are Ref
intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }
.
\n ResourceAttribute
entities are Fn::GetAtt
intrinsic functions that get resource attribute\n values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }
.
\n DirectModification
entities are changes that are made directly to the template.
\n Automatic
entities are AWS::CloudFormation::Stack
resource types, which are also known as\n nested stacks. If you made no changes to the AWS::CloudFormation::Stack
resource, CloudFormation\n sets the ChangeSource
to Automatic
because the nested stack's template might have\n changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the\n parent stack.
The reason for the resource detail, providing more information if a failure happened.
" } }, - "CausingEntity": { - "target": "com.amazonaws.cloudformation#CausingEntity", + "Warnings": { + "target": "com.amazonaws.cloudformation#WarningDetails", "traits": { - "smithy.api#documentation": "The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource
field. For example, if you modified the value of the KeyPairName
\n parameter, the CausingEntity
is the name of the parameter (KeyPairName
).
If the ChangeSource
value is DirectModification
, no value is given for\n CausingEntity
.
The warnings generated for this resource.
" } } }, "traits": { - "smithy.api#documentation": "For a resource with Modify
as the action, the ResourceChange
structure describes the\n changes CloudFormation will make to that resource.
Details about a resource in a generated template
" } }, - "com.amazonaws.cloudformation#ResourceChangeDetails": { + "com.amazonaws.cloudformation#ResourceDetails": { "type": "list", "member": { - "target": "com.amazonaws.cloudformation#ResourceChangeDetail" + "target": "com.amazonaws.cloudformation#ResourceDetail" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } } }, + "com.amazonaws.cloudformation#ResourceIdentifier": { + "type": "string" + }, "com.amazonaws.cloudformation#ResourceIdentifierProperties": { "type": "map", "key": { @@ -9026,6 +10221,145 @@ "com.amazonaws.cloudformation#ResourceProperties": { "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 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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the resource scan. This is returned by the ListResourceScan
API action.
The type of the resource, such as AWS::DynamoDB::Table
. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier
list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table
resource, the primary identifiers is TableName
so the key-value pair\n could be \"TableName\": \"MyDDBTable\"
. For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.
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 supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier
list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table
resource, the primary identifiers is TableName
so the key-value pair\n could be \"TableName\": \"MyDDBTable\"
. For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.
Identifies a scanned resource. This is used with the ListResourceScanRelatedResources
API\n action.
The order of the Regions where you want to perform the stack operation.
" + "smithy.api#documentation": "The order of the Regions where you want to perform the stack operation.
\n\n RegionOrder
isn't followed if AutoDeployment
is enabled.
Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
" + "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 and any values\n specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The StackSummary Data Type
" + } + }, + "com.amazonaws.cloudformation#Stacks": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#Stack" + } + }, + "com.amazonaws.cloudformation#StageList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TemplateStage" + } + }, + "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 stack set 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 scan using the\n ListResourceScans
API action.
A unique identifier for this StartResourceScan
request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to start a new resource scan.
The StackSummary Data Type
" - } - }, - "com.amazonaws.cloudformation#Stacks": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#Stack" - } - }, - "com.amazonaws.cloudformation#StageList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TemplateStage" + "smithy.api#input": {} } }, - "com.amazonaws.cloudformation#StaleRequestException": { + "com.amazonaws.cloudformation#StartResourceScanOutput": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" + "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 example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n
.
Another operation has been performed on this stack set since the specified operation was performed.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 + "smithy.api#output": {} } }, "com.amazonaws.cloudformation#StatusMessage": { @@ -12128,9 +13622,46 @@ } } }, + "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 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 \n DeletionPolicy
\n attribute in the CloudFormation User Guide.
The UpdateReplacePolicy
assigned to resources in the generated template. Supported values\n are:
\n DELETE
- delete all resources when the resource is replaced during an update operation.
\n RETAIN
- retain all resources when the resource is replaced during an update operation.
For more information, see \n UpdateReplacePolicy
\n attribute in the CloudFormation User Guide.
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": { @@ -12169,6 +13700,38 @@ "target": "com.amazonaws.cloudformation#TemplateParameter" } }, + "com.amazonaws.cloudformation#TemplateProgress": { + "type": "structure", + "members": { + "ResourcesSucceeded": { + "target": "com.amazonaws.cloudformation#ResourcesSucceeded", + "traits": { + "smithy.api#documentation": "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": { @@ -12186,6 +13749,71 @@ } } }, + "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 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 failure\n 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, in-progress,\n completed, and failed states.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of a generated template.
" + } + }, "com.amazonaws.cloudformation#TemplateSummaryConfig": { "type": "structure", "members": { @@ -12351,6 +13979,14 @@ } } }, + "com.amazonaws.cloudformation#TotalWarnings": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.cloudformation#TransformName": { "type": "string" }, @@ -12818,6 +14454,140 @@ "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 resources, refresh resources,\n and change the DeletionPolicy
and UpdateReplacePolicy
settings. You can check the status of\n the update to the 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 current live state.\n This feature is useful when the resource properties in your generated a template does not reflect the live state of\n the resource properties. This happens when a user update the resource properties after generating a template.
The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}
. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n
.
The type of this warning. For more information, see IaC generator and write-only\n properties in the CloudFormation User Guide.
\n\n MUTUALLY_EXCLUSIVE_PROPERTIES
- The resource requires mutually-exclusive write-only properties.\n The IaC generator selects one set of mutually exclusive properties and converts the included properties into\n parameters. The parameter names have a suffix OneOf
and the parameter descriptions indicate that the\n corresponding property can be replaced with other exclusive properties.
\n UNSUPPORTED_PROPERTIES
- Unsupported properties are present in the resource. One example of\n unsupported properties would be a required write-only property that is an array, because a parameter cannot be an\n array. Another example is an optional write-only property.
\n MUTUALLY_EXCLUSIVE_TYPES
- One or more required write-only properties are found in the resource,\n 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 uses a type of\n oneOf
or anyOf
. You need to look at the resource 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 the Code
\n 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" + } + } + } + }, "com.amazonaws.cloudformation#Warnings": { "type": "structure", "members": { diff --git a/aws-models/elastic-load-balancing-v2.json b/aws-models/elastic-load-balancing-v2.json index 32c4a8e90051..086c3188548a 100644 --- a/aws-models/elastic-load-balancing-v2.json +++ b/aws-models/elastic-load-balancing-v2.json @@ -971,6 +971,49 @@ } ] } + }, + { + "title": "To create an HTTPS listener", + "documentation": "This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).", + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Protocol": "HTTPS", + "Port": 443, + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "DefaultActions": [ + { + "Type": "forward", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + } + ] + }, + "output": { + "Listeners": [ + { + "Protocol": "HTTPS", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + } + ] + } } ] } @@ -1147,6 +1190,49 @@ } ] } + }, + { + "title": "To create an internal load balancer", + "documentation": "This example creates an internal load balancer and enables the Availability Zones for the specified subnets.", + "input": { + "Name": "my-internal-load-balancer", + "Subnets": [ + "subnet-b7d581c0", + "subnet-8360a9e7" + ], + "SecurityGroups": [], + "Scheme": "internal" + }, + "output": { + "LoadBalancers": [ + { + "VpcId": "vpc-3ac0fb5f", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2", + "State": { + "Code": "provisioning" + }, + "DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com", + "SecurityGroups": [ + "sg-5943793c" + ], + "LoadBalancerName": "my-internal-load-balancer", + "CreatedTime": "2016-03-25T21:29:48.850Z", + "Scheme": "internal", + "Type": "application", + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ] + } + ] + } } ] } @@ -1165,13 +1251,13 @@ "Subnets": { "target": "com.amazonaws.elasticloadbalancingv2#Subnets", "traits": { - "smithy.api#documentation": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both. To specify an Elastic IP\n address, specify subnet mappings instead of subnets.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.
" + "smithy.api#documentation": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both. To specify an Elastic IP\n address, specify subnet mappings instead of subnets.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.
" } }, "SubnetMappings": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { - "smithy.api#documentation": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You\n cannot specify Elastic IP addresses for your subnets.
" + "smithy.api#documentation": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You\n cannot specify Elastic IP addresses for your subnets.
" } }, "SecurityGroups": { @@ -3111,6 +3197,33 @@ } ] } + }, + { + "title": "To describe the health of a target", + "documentation": "This example describes the health of the specified target. This target is healthy.", + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Targets": [ + { + "Id": "i-0f76fade", + "Port": 80 + } + ] + }, + "output": { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + } + ] + } } ], "smithy.api#suppress": [ @@ -5823,6 +5936,40 @@ } ] } + }, + { + "title": "To change the server certificate", + "documentation": "This example changes the server certificate for the specified HTTPS listener.", + "input": { + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ] + }, + "output": { + "Listeners": [ + { + "Protocol": "HTTPS", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" + } + ] + } } ] } @@ -5954,6 +6101,88 @@ } ] } + }, + { + "title": "To change the idle timeout", + "documentation": "This example changes the idle timeout value for the specified load balancer.", + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Attributes": [ + { + "Key": "idle_timeout.timeout_seconds", + "Value": "30" + } + ] + }, + "output": { + "Attributes": [ + { + "Value": "30", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "false", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "true", + "Key": "deletion_protection.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.bucket" + } + ] + } + }, + { + "title": "To enable access logs", + "documentation": "This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.", + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Attributes": [ + { + "Key": "access_logs.s3.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "my-loadbalancer-logs" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "myapp" + } + ] + }, + "output": { + "Attributes": [ + { + "Value": "true", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "my-load-balancer-logs", + "Key": "access_logs.s3.bucket" + }, + { + "Value": "myapp", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "60", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "false", + "Key": "deletion_protection.enabled" + } + ] + } } ] } @@ -6775,6 +7004,23 @@ } ] } + }, + { + "title": "To register targets with a target group using port overrides", + "documentation": "This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.", + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9", + "Targets": [ + { + "Id": "i-80c8dd94", + "Port": 80 + }, + { + "Id": "i-80c8dd94", + "Port": 766 + } + ] + } } ] } @@ -7668,7 +7914,7 @@ "Values": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { - "smithy.api#documentation": "The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses.\n Wildcards are not supported.
\nIf you specify multiple addresses, the condition is satisfied if the source IP address of\n the request matches one of the CIDR blocks. This condition is not satisfied by the addresses\n in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use\n HttpHeaderConditionConfig.
" + "smithy.api#documentation": "The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses.\n Wildcards are not supported.
\nIf you specify multiple addresses, the condition is satisfied if the source IP address of\n the request matches one of the CIDR blocks. This condition is not satisfied by the addresses\n in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use\n HttpHeaderConditionConfig.
\nThe total number of values must be less than, or equal to five.
" } } }, @@ -8072,7 +8318,7 @@ "Key": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeKey", "traits": { - "smithy.api#documentation": "The name of the attribute.
\nThe following attributes are supported by all load balancers:
\n\n deregistration_delay.timeout_seconds
- The amount of time, in seconds,\n for Elastic Load Balancing to wait before changing the state of a deregistering target\n from draining
to unused
. The range is 0-3600 seconds. The\n default value is 300 seconds. If the target is a Lambda function, this attribute is not\n supported.
\n stickiness.enabled
- Indicates whether target stickiness is enabled. The\n value is true
or false
. The default is\n false
.
\n stickiness.type
- Indicates the type of stickiness. The possible values are:
\n lb_cookie
and app_cookie
for Application Load Balancers.
\n source_ip
for Network Load Balancers.
\n source_ip_dest_ip
and source_ip_dest_ip_proto
for Gateway Load Balancers.
The following attributes are supported by Application Load Balancers and \n Network Load Balancers:
\n\n load_balancing.cross_zone.enabled
- Indicates whether cross zone load \n balancing is enabled. The value is true
, false
or \n use_load_balancer_configuration
. The default is \n use_load_balancer_configuration
.
\n target_group_health.dns_failover.minimum_healthy_targets.count
- \n The minimum number of targets that must be healthy.\n If the number of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n off
or an integer from 1 to the maximum number of targets.\n The default is off
.
\n target_group_health.dns_failover.minimum_healthy_targets.percentage
- \n The minimum percentage of targets that must be healthy.\n If the percentage of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n off
or an integer from 1 to 100. The default is off
.
\n target_group_health.unhealthy_state_routing.minimum_healthy_targets.count
- \n The minimum number of targets that must be healthy. \n If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n The possible values are 1 to the maximum number of targets. The default is 1.
\n target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage
- \n The minimum percentage of targets that must be healthy. \n If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n The possible values are off
or an integer from 1 to 100.\n The default is off
.
The following attributes are supported only if the load balancer is an Application Load\n Balancer and the target is an instance or an IP address:
\n\n load_balancing.algorithm.type
- The load balancing algorithm determines\n how the load balancer selects targets when routing requests. The value is\n round_robin
, least_outstanding_requests
, or weighted_random
. The default is\n round_robin
.
\n load_balancing.algorithm.anomaly_mitigation
- Only available when load_balancing.algorithm.type
\n is weighted_random
. Indicates whether anomaly mitigation is enabled. The value is on
\n or off
. The default is off
.
\n slow_start.duration_seconds
- The time period, in seconds, during which a\n newly registered target receives an increasing share of the traffic to the target group.\n After this time period ends, the target receives its full share of traffic. The range is\n 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
\n stickiness.app_cookie.cookie_name
- Indicates the name of the\n application-based cookie. Names that start with the following prefixes are not allowed:\n AWSALB
, AWSALBAPP
, and AWSALBTG
; they're reserved\n for use by the load balancer.
\n stickiness.app_cookie.duration_seconds
- The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the application-based cookie is considered stale. The range is 1 second to\n 1 week (604800 seconds). The default value is 1 day (86400 seconds).
\n stickiness.lb_cookie.duration_seconds
- The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the load balancer-generated cookie is considered stale. The range is 1\n second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load\n Balancer and the target is a Lambda function:
\n\n lambda.multi_value_headers.enabled
- Indicates whether the request and\n response headers that are exchanged between the load balancer and the Lambda function\n include arrays of values or strings. The value is true
or false
.\n The default is false
. If the value is false
and the request\n contains a duplicate header field name or query parameter key, the load balancer uses the\n last value sent by the client.
The following attributes are supported only by Network Load Balancers:
\n\n deregistration_delay.connection_termination.enabled
- Indicates whether\n the load balancer terminates connections at the end of the deregistration timeout. The\n value is true
or false
. For new UDP/TCP_UDP target groups the \n default is true
. Otherwise, the default is false
.
\n preserve_client_ip.enabled
- Indicates whether client IP preservation is\n enabled. The value is true
or false
. The default is disabled if\n the target group type is IP address and the target group protocol is TCP or TLS.\n Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and\n TCP_UDP target groups.
\n proxy_protocol_v2.enabled
- Indicates whether Proxy Protocol version 2 is\n enabled. The value is true
or false
. The default is\n false
.
\n target_health_state.unhealthy.connection_termination.enabled
- Indicates whether \n the load balancer terminates connections to unhealthy targets. The value is true
\n or false
. The default is true
.
The following attributes are supported only by Gateway Load Balancers:
\n\n target_failover.on_deregistration
- Indicates how the Gateway Load\n Balancer handles existing flows when a target is deregistered. The possible values are\n rebalance
and no_rebalance
. The default is\n no_rebalance
. The two attributes\n (target_failover.on_deregistration
and\n target_failover.on_unhealthy
) can't be set independently. The value you set\n for both attributes must be the same.
\n target_failover.on_unhealthy
- Indicates how the Gateway Load Balancer\n handles existing flows when a target is unhealthy. The possible values are\n rebalance
and no_rebalance
. The default is\n no_rebalance
. The two attributes\n (target_failover.on_deregistration
and\n target_failover.on_unhealthy
) cannot be set independently. The value you\n set for both attributes must be the same.
The name of the attribute.
\nThe following attributes are supported by all load balancers:
\n\n deregistration_delay.timeout_seconds
- The amount of time, in seconds,\n for Elastic Load Balancing to wait before changing the state of a deregistering target\n from draining
to unused
. The range is 0-3600 seconds. The\n default value is 300 seconds. If the target is a Lambda function, this attribute is not\n supported.
\n stickiness.enabled
- Indicates whether target stickiness is enabled. The\n value is true
or false
. The default is\n false
.
\n stickiness.type
- Indicates the type of stickiness. The possible values are:
\n lb_cookie
and app_cookie
for Application Load Balancers.
\n source_ip
for Network Load Balancers.
\n source_ip_dest_ip
and source_ip_dest_ip_proto
for Gateway Load Balancers.
The following attributes are supported by Application Load Balancers and \n Network Load Balancers:
\n\n load_balancing.cross_zone.enabled
- Indicates whether cross zone load \n balancing is enabled. The value is true
, false
or \n use_load_balancer_configuration
. The default is \n use_load_balancer_configuration
.
\n target_group_health.dns_failover.minimum_healthy_targets.count
- \n The minimum number of targets that must be healthy.\n If the number of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n off
or an integer from 1 to the maximum number of targets.\n The default is off
.
\n target_group_health.dns_failover.minimum_healthy_targets.percentage
- \n The minimum percentage of targets that must be healthy.\n If the percentage of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n off
or an integer from 1 to 100. The default is off
.
\n target_group_health.unhealthy_state_routing.minimum_healthy_targets.count
- \n The minimum number of targets that must be healthy. \n If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n The possible values are 1 to the maximum number of targets. The default is 1.
\n target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage
- \n The minimum percentage of targets that must be healthy. \n If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n The possible values are off
or an integer from 1 to 100.\n The default is off
.
The following attributes are supported only if the load balancer is an Application Load\n Balancer and the target is an instance or an IP address:
\n\n load_balancing.algorithm.type
- The load balancing algorithm determines\n how the load balancer selects targets when routing requests. The value is\n round_robin
, least_outstanding_requests
, or weighted_random
. The default is\n round_robin
.
\n load_balancing.algorithm.anomaly_mitigation
- Only available when load_balancing.algorithm.type
\n is weighted_random
. Indicates whether anomaly mitigation is enabled. The value is on
\n or off
. The default is off
.
\n slow_start.duration_seconds
- The time period, in seconds, during which a\n newly registered target receives an increasing share of the traffic to the target group.\n After this time period ends, the target receives its full share of traffic. The range is\n 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
\n stickiness.app_cookie.cookie_name
- Indicates the name of the\n application-based cookie. Names that start with the following prefixes are not allowed:\n AWSALB
, AWSALBAPP
, and AWSALBTG
; they're reserved\n for use by the load balancer.
\n stickiness.app_cookie.duration_seconds
- The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the application-based cookie is considered stale. The range is 1 second to\n 1 week (604800 seconds). The default value is 1 day (86400 seconds).
\n stickiness.lb_cookie.duration_seconds
- The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the load balancer-generated cookie is considered stale. The range is 1\n second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load\n Balancer and the target is a Lambda function:
\n\n lambda.multi_value_headers.enabled
- Indicates whether the request and\n response headers that are exchanged between the load balancer and the Lambda function\n include arrays of values or strings. The value is true
or false
.\n The default is false
. If the value is false
and the request\n contains a duplicate header field name or query parameter key, the load balancer uses the\n last value sent by the client.
The following attributes are supported only by Network Load Balancers:
\n\n deregistration_delay.connection_termination.enabled
- Indicates whether\n the load balancer terminates connections at the end of the deregistration timeout. The\n value is true
or false
. For new UDP/TCP_UDP target groups the \n default is true
. Otherwise, the default is false
.
\n preserve_client_ip.enabled
- Indicates whether client IP preservation is\n enabled. The value is true
or false
. The default is disabled if\n the target group type is IP address and the target group protocol is TCP or TLS.\n Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and\n TCP_UDP target groups.
\n proxy_protocol_v2.enabled
- Indicates whether Proxy Protocol version 2 is\n enabled. The value is true
or false
. The default is\n false
.
\n target_health_state.unhealthy.connection_termination.enabled
- Indicates whether \n the load balancer terminates connections to unhealthy targets. The value is true
\n or false
. The default is true
.
\n target_health_state.unhealthy.draining_interval_seconds
- The amount of time \n for Elastic Load Balancing to wait before changing the state of an unhealthy target from \n unhealthy.draining
to unhealthy
. The range is 0-360000 seconds. \n The default value is 0 seconds.
Note: This attribute can only be configured when \n target_health_state.unhealthy.connection_termination.enabled
is false
.
The following attributes are supported only by Gateway Load Balancers:
\n\n target_failover.on_deregistration
- Indicates how the Gateway Load\n Balancer handles existing flows when a target is deregistered. The possible values are\n rebalance
and no_rebalance
. The default is\n no_rebalance
. The two attributes\n (target_failover.on_deregistration
and\n target_failover.on_unhealthy
) can't be set independently. The value you set\n for both attributes must be the same.
\n target_failover.on_unhealthy
- Indicates how the Gateway Load Balancer\n handles existing flows when a target is unhealthy. The possible values are\n rebalance
and no_rebalance
. The default is\n no_rebalance
. The two attributes\n (target_failover.on_deregistration
and\n target_failover.on_unhealthy
) cannot be set independently. The value you\n set for both attributes must be the same.
The maximum size of the response.
" } @@ -19646,7 +19646,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "target": "com.amazonaws.glue#OrchestrationPageSize200", "traits": { "smithy.api#documentation": "The maximum size of the response.
" } @@ -22089,7 +22089,7 @@ "Runtime": { "target": "com.amazonaws.glue#RuntimeNameString", "traits": { - "smithy.api#documentation": "In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional\n libraries available in your environment. This field is not used in other job types. For\n supported runtime environment values, see Working with Ray jobs\n in the Glue Developer Guide.
" + "smithy.api#documentation": "In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional\n libraries available in your environment. This field is not used in other job types. For\n supported runtime environment values, see Supported Ray runtime environments\n in the Glue Developer Guide.
" } } }, @@ -23188,7 +23188,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "target": "com.amazonaws.glue#OrchestrationPageSize25", "traits": { "smithy.api#documentation": "The maximum size of a list to return.
" } @@ -24616,7 +24616,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "target": "com.amazonaws.glue#OrchestrationPageSize200", "traits": { "smithy.api#documentation": "The maximum size of a list to return.
" } @@ -24690,7 +24690,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "target": "com.amazonaws.glue#OrchestrationPageSize25", "traits": { "smithy.api#documentation": "The maximum size of a list to return.
" } @@ -25996,6 +25996,24 @@ "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, + "com.amazonaws.glue#OrchestrationPageSize200": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.glue#OrchestrationPageSize25": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, "com.amazonaws.glue#OrchestrationRoleArn": { "type": "string", "traits": { diff --git a/aws-models/sdk-endpoints.json b/aws-models/sdk-endpoints.json index a82679440588..44492f21523b 100644 --- a/aws-models/sdk-endpoints.json +++ b/aws-models/sdk-endpoints.json @@ -16869,6 +16869,7 @@ "deprecated" : true, "hostname" : "sms-voice-fips.us-west-2.amazonaws.com" }, + "il-central-1" : { }, "us-east-1" : { "variants" : [ { "hostname" : "sms-voice-fips.us-east-1.amazonaws.com", diff --git a/aws-models/ssm.json b/aws-models/ssm.json index 8511482b06a5..cc5f43713a5c 100644 --- a/aws-models/ssm.json +++ b/aws-models/ssm.json @@ -2031,6 +2031,12 @@ "smithy.api#documentation": "Number of days to wait after the scheduled day to run an association.
" } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "The number of hours that an association can run on specified targets. After the resulting\n cutoff time passes, associations that are currently running are cancelled, and no pending\n executions are started on remaining targets.
" + } + }, "TargetMaps": { "target": "com.amazonaws.ssm#TargetMaps", "traits": { @@ -2243,6 +2249,12 @@ "smithy.api#documentation": "Number of days to wait after the scheduled day to run an association.
" } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "The number of hours that an association can run on specified targets. After the resulting\n cutoff time passes, associations that are currently running are cancelled, and no pending\n executions are started on remaining targets.
" + } + }, "TargetMaps": { "target": "com.amazonaws.ssm#TargetMaps", "traits": { @@ -3007,6 +3019,12 @@ "smithy.api#documentation": "Number of days to wait after the scheduled day to run an association.
" } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "The number of hours that an association can run on specified targets. After the resulting\n cutoff time passes, associations that are currently running are cancelled, and no pending\n executions are started on remaining targets.
" + } + }, "TargetMaps": { "target": "com.amazonaws.ssm#TargetMaps", "traits": { @@ -5924,6 +5942,12 @@ "smithy.api#documentation": "Number of days to wait after the scheduled day to run an association.
" } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "The number of hours the association can run before it is canceled. Duration applies to\n associations that are currently running, and any pending and in progress commands on all targets.\n If a target was taken offline for the association to run, it is made available again immediately,\n without a reboot.
\nThe Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters\n of the SSM command document or Automation runbook associated with this execution.
\nThe command specifies the \n ApplyOnlyAtCronInterval\n
parameter, which means that the association doesn't\n run immediately after it is created, but only according to the specified schedule.
Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *)
, you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information\n about cron schedules for associations, see Reference: Cron\n and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This\n option tells the system not to run an association immediately after you create it.
The number of hours the association can run before it is canceled. Duration applies to\n associations that are currently running, and any pending and in progress commands on all targets.\n If a target was taken offline for the association to run, it is made available again immediately,\n without a reboot.
\nThe Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters\n of the SSM command document or Automation runbook associated with this execution.
\nThe command specifies the \n ApplyOnlyAtCronInterval\n
parameter, which means that the association doesn't\n run immediately after it is created, but only according to the specified schedule.
Lists all patches eligible to be included in a patch baseline.
", + "smithy.api#documentation": "Lists all patches eligible to be included in a patch baseline.
\nCurrently, DescribeAvailablePatches
supports only the Amazon Linux 1, Amazon\n Linux 2, and Windows Server operating systems.
An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n can't be changed.
" + "smithy.api#documentation": "An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and\n can't be changed.
" } } }, @@ -10784,7 +10814,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n can't be changed.
" + "smithy.api#documentation": "An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and\n can't be changed.
" } }, "PlatformTypes": { @@ -11095,7 +11125,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n can't be changed.
" + "smithy.api#documentation": "An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and\n can't be changed.
" } } }, @@ -11436,7 +11466,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "The version of the artifact associated with the document. For example, \"Release 12, Update\n 6\". This value is unique across all versions of a document, and can't be changed.
" + "smithy.api#documentation": "The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
" } }, "CreatedDate": { @@ -11586,6 +11616,15 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#Duration": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 24 + } + } + }, "com.amazonaws.ssm#EffectiveInstanceAssociationMaxResults": { "type": "integer", "traits": { @@ -12201,7 +12240,7 @@ "Status": { "target": "com.amazonaws.ssm#ConnectionStatus", "traits": { - "smithy.api#documentation": "The status of the connection to the managed node. For example, 'Connected' or 'Not\n Connected'.
" + "smithy.api#documentation": "The status of the connection to the managed node.
" } } }, @@ -12379,7 +12418,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document and can't\n be changed.
" + "smithy.api#documentation": "An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document and can't\n be changed.
" } }, "DocumentVersion": { @@ -12423,7 +12462,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "The version of the artifact associated with the document. For example, \"Release 12, Update\n 6\". This value is unique across all versions of a document, and can't be changed.
" + "smithy.api#documentation": "The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
" } }, "DocumentVersion": { @@ -21808,7 +21847,7 @@ "KeyId": { "target": "com.amazonaws.ssm#ParameterKeyId", "traits": { - "smithy.api#documentation": "The ID of the query key used for this parameter.
" + "smithy.api#documentation": "The alias of the Key Management Service (KMS) key used to encrypt the\n parameter. Applies to SecureString
parameters only
The ID of the query key used for this parameter.
" + "smithy.api#documentation": "The alias of the Key Management Service (KMS) key used to encrypt the\n parameter. Applies to SecureString
parameters only.
The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by\n the patch.
" + "smithy.api#documentation": "The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by\n the patch.
\nCurrently, CVE ID values are reported only for patches with a status of\n Missing
or Failed
.
Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *)
, you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information\n about cron schedules for associations, see Reference: Cron\n and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This\n option tells the system not to run an association immediately after you create it.
The number of hours the association can run before it is canceled. Duration applies to\n associations that are currently running, and any pending and in progress commands on all targets.\n If a target was taken offline for the association to run, it is made available again immediately,\n without a reboot.
\nThe Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters\n of the SSM command document or Automation runbook associated with this execution.
\nThe command specifies the \n ApplyOnlyAtCronInterval\n
parameter, which means that the association doesn't\n run immediately after it is updated, but only according to the specified schedule.
An optional field specifying the version of the artifact you are updating with the document.\n For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n can't be changed.
" + "smithy.api#documentation": "An optional field specifying the version of the artifact you are updating with the document.\n For example, 12.6. This value is unique across all versions of a document, and\n can't be changed.
" } }, "DocumentVersion": { diff --git a/examples/examples/cloudformation/Cargo.toml b/examples/examples/cloudformation/Cargo.toml index a8273b7d7a59..61268842b127 100644 --- a/examples/examples/cloudformation/Cargo.toml +++ b/examples/examples/cloudformation/Cargo.toml @@ -8,7 +8,7 @@ publish = false [dependencies] aws-config= { version = "1.1.4", path = "../../../sdk/aws-config", features = ["behavior-version-latest"] } -aws-sdk-cloudformation= { version = "1.13.0", path = "../../../sdk/cloudformation" } +aws-sdk-cloudformation= { version = "1.14.0", path = "../../../sdk/cloudformation" } [dependencies.tokio] version = "1.20.1" diff --git a/examples/examples/glue/Cargo.toml b/examples/examples/glue/Cargo.toml index f2f8bbf0bb0b..ca386594a24c 100644 --- a/examples/examples/glue/Cargo.toml +++ b/examples/examples/glue/Cargo.toml @@ -19,7 +19,7 @@ secrecy = "0.8.0" futures = "0.3.25" tracing-bunyan-formatter = "0.3.4" aws-config= { version = "1.1.4", path = "../../../sdk/aws-config", features = ["behavior-version-latest"] } -aws-sdk-glue= { version = "1.14.0", path = "../../../sdk/glue" } +aws-sdk-glue= { version = "1.15.0", path = "../../../sdk/glue" } aws-sdk-s3= { version = "1.14.0", path = "../../../sdk/s3" } aws-http= { version = "0.60.5", path = "../../../sdk/aws-http" } aws-smithy-types= { version = "1.1.4", path = "../../../sdk/aws-smithy-types" } diff --git a/examples/examples/ssm/Cargo.toml b/examples/examples/ssm/Cargo.toml index 39d2121efc93..126c15ad3193 100644 --- a/examples/examples/ssm/Cargo.toml +++ b/examples/examples/ssm/Cargo.toml @@ -8,7 +8,7 @@ publish = false [dependencies] aws-config= { version = "1.1.4", path = "../../../sdk/aws-config", features = ["behavior-version-latest"] } -aws-sdk-ssm= { version = "1.12.0", path = "../../../sdk/ssm" } +aws-sdk-ssm= { version = "1.13.0", path = "../../../sdk/ssm" } [dependencies.tokio] version = "1.20.1" diff --git a/sdk/cloudformation/Cargo.toml b/sdk/cloudformation/Cargo.toml index 0950183a9ae4..8b8dc7221d71 100644 --- a/sdk/cloudformation/Cargo.toml +++ b/sdk/cloudformation/Cargo.toml @@ -1,7 +1,7 @@ # Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT. [package] name = "aws-sdk-cloudformation" -version = "1.13.0" +version = "1.14.0" authors = ["AWS Rust SDK TeamAn optional list of resources to be included in the generated template.
If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate
API action.
The name assigned to the generated template.
An optional name or ARN of a stack to use as the base stack for the generated template.
The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The ID of the generated template.
+ /// - On failure, responds with [`SdkErrorA list of Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
Set to true
to disable rollback of the stack if stack creation failed. You can specify either DisableRollback
or OnFailure
, but not both.
Default: false
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM
or CAPABILITY_NAMED_IAM
capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM
.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities
error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities
and ResourceType
parameters can be specified.
The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance
, AWS::EC2::*
, or Custom::MyCustomInstance
. Use the following syntax to describe template resource types: AWS::*
(for all Amazon Web Services resources), Custom::*
(for all custom resources), Custom::logical_ID
(for a specific custom resource), AWS::service_name::*
(for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID
(for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities
and ResourceType
parameters can be specified.
The name or Amazon Resource Name (ARN) of a generated template.
The name or Amazon Resource Name (ARN) of a generated template.
The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}
. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
.
The name of the generated template.
+ /// - [`resources(OptionA list of objects describing the details of the resources in the template generation.
+ /// - [`status(OptionThe status of the template generation. Supported values are:
CreatePending
- the creation of the template is pending.
CreateInProgress
- the creation of the template is in progress.
DeletePending
- the deletion of the template is pending.
DeleteInProgress
- the deletion of the template is in progress.
UpdatePending
- the update of the template is pending.
UpdateInProgress
- the update of the template is in progress.
Failed
- the template operation failed.
Complete
- the template operation is complete.
The reason for the current template generation status. This will provide more details if a failure happened.
+ /// - [`creation_time(OptionThe time the generated template was created.
+ /// - [`last_updated_time(OptionThe time the generated template was last updated.
+ /// - [`progress(OptionAn object describing the progress of the template generation.
+ /// - [`stack_id(OptionThe stack ARN of the base stack if a base stack was provided when generating the template.
+ /// - [`template_configuration(OptionThe configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
+ /// - On failure, responds with [`SdkErrorThe Amazon Resource Name (ARN) of the resource scan.
The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}
. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
.
Status of the resource scan.
The resource scan is still in progress.
The resource scan is complete.
The resource scan has expired.
The resource scan has failed.
The reason for the resource scan status, providing more information if a failure happened.
+ /// - [`start_time(OptionThe time that the resource scan was started.
+ /// - [`end_time(OptionThe time that the resource scan was finished.
+ /// - [`percentage_completed(OptionThe percentage of the resource scan that has been completed.
+ /// - [`resource_types(OptionThe list of resource types for the specified scan. Resource types are only available for scans with a Status
set to COMPLETE
or FAILED
.
The number of resources that were listed. This is only available for scans with a Status
set to COMPLETE
, EXPIRED
, or FAILED
.
The number of resources that were read. This is only available for scans with a Status
set to COMPLETE
, EXPIRED
, or FAILED
.
This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException
.
The language to use to retrieve for the generated template. Supported values are:
JSON
YAML
The name or Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}
. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
.
The status of the template generation. Supported values are:
CreatePending
- the creation of the template is pending.
CreateInProgress
- the creation of the template is in progress.
DeletePending
- the deletion of the template is pending.
DeleteInProgress
- the deletion of the template is in progress.
UpdatePending
- the update of the template is pending.
UpdateInProgress
- the update of the template is in progress.
Failed
- the template operation failed.
Complete
- the template operation is complete.
The template body of the generated template, in the language specified by the Language
parameter.
A string that identifies the next page of resource scan results.
If the number of available results exceeds this maximum, the response includes a NextToken
value that you can use for the NextToken
parameter to get the next set of results. By default the ListGeneratedTemplates
API action will return at most 50 results in each response. The maximum value is 100.
A list of summaries of the generated templates.
+ /// - [`next_token(OptionIf the request doesn't return all the remaining results, NextToken
is set to a token. To retrieve the next set of results, call ListGeneratedTemplates
again and use that value for the NextToken
parameter. If the request returns all results, NextToken
is set to an empty string.
The Amazon Resource Name (ARN) of the resource scan.
The list of resources for which you want to get the related resources. Up to 100 resources can be provided.
A string that identifies the next page of resource scan results.
If the number of available results exceeds this maximum, the response includes a NextToken
value that you can use for the NextToken
parameter to get the next set of results. By default the ListResourceScanRelatedResources
API 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 the specified resources.
If the request doesn't return all the remaining results, NextToken
is set to a token. To retrieve the next set of results, call ListResourceScanRelatedResources
again and use that value for the NextToken
parameter. If the request returns all results, NextToken
is set to an empty string.
The Amazon Resource Name (ARN) of the resource scan.
If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers).
If specified, the returned resources will be of any of the resource types with the specified prefix.
If specified, the returned resources will have a matching tag key.
If specified, the returned resources will have a matching tag value.
A string that identifies the next page of resource scan results.
If the number of available results exceeds this maximum, the response includes a NextToken
value that you can use for the NextToken
parameter to get the next set of results. By default the ListResourceScanResources
API action 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 all of the specified filters.
If the request doesn't return all the remaining results, NextToken
is set to a token. To retrieve the next set of results, call ListResourceScanResources
again and use that value for the NextToken
parameter. If the request returns all results, NextToken
is set to an empty string.
A string that identifies the next page of resource scan results.
If the number of available results exceeds this maximum, the response includes a NextToken
value that you can use for the NextToken
parameter to get the next set of results. The default value is 10. The maximum value is 100.
The list of scans returned.
+ /// - [`next_token(OptionIf the request doesn't return all the remaining results, NextToken
is set to a token. To retrieve the next set of results, call ListResourceScans
again and use that value for the NextToken
parameter. If the request returns all results, NextToken
is set to an empty string.
A unique identifier for this StartResourceScan
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to start a new resource scan.
The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}
. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
.
The name or Amazon Resource Name (ARN) of a generated template.
An optional new name to assign to the generated template.
An optional list of resources to be added to the generated template.
A list of logical ids for resources to remove from the generated template.
If true
, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.
The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}
. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
.
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets
operation.
No more than 5 generated templates can be in an InProgress
or Pending
status at one time. This error is also returned if a generated template that is in an InProgress
or Pending
status is attempted to be updated or deleted.
The specified resource exists, but has been changed.
CreatedButModifiedException(crate::types::error::CreatedButModifiedException), + ///The generated template was not found.
+ GeneratedTemplateNotFoundException(crate::types::error::GeneratedTemplateNotFoundException), ///The template contains resources with capabilities that weren't specified in the Capabilities parameter.
InsufficientCapabilitiesException(crate::types::error::InsufficientCapabilitiesException), ///The specified change set can't be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS
, or the stack status might be UPDATE_IN_PROGRESS
.
Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.
OperationStatusCheckFailedException(crate::types::error::OperationStatusCheckFailedException), + ///A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
+ ResourceScanInProgressException(crate::types::error::ResourceScanInProgressException), + ///The limit on resource scans has been exceeded. Reasons include:
+ ///Exceeded the daily quota for resource scans.
A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.
The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.
The resource scan was not found.
+ ResourceScanNotFoundException(crate::types::error::ResourceScanNotFoundException), ///The specified stack instance doesn't exist.
StackInstanceNotFoundException(crate::types::error::StackInstanceNotFoundException), ///The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.
@@ -63,7 +81,9 @@ impl ::std::fmt::Display for Error { Error::AlreadyExistsException(inner) => inner.fmt(f), Error::CfnRegistryException(inner) => inner.fmt(f), Error::ChangeSetNotFoundException(inner) => inner.fmt(f), + Error::ConcurrentResourcesLimitExceededException(inner) => inner.fmt(f), Error::CreatedButModifiedException(inner) => inner.fmt(f), + Error::GeneratedTemplateNotFoundException(inner) => inner.fmt(f), Error::InsufficientCapabilitiesException(inner) => inner.fmt(f), Error::InvalidChangeSetStatusException(inner) => inner.fmt(f), Error::InvalidOperationException(inner) => inner.fmt(f), @@ -74,6 +94,9 @@ impl ::std::fmt::Display for Error { Error::OperationInProgressException(inner) => inner.fmt(f), Error::OperationNotFoundException(inner) => inner.fmt(f), Error::OperationStatusCheckFailedException(inner) => inner.fmt(f), + Error::ResourceScanInProgressException(inner) => inner.fmt(f), + Error::ResourceScanLimitExceededException(inner) => inner.fmt(f), + Error::ResourceScanNotFoundException(inner) => inner.fmt(f), Error::StackInstanceNotFoundException(inner) => inner.fmt(f), Error::StackNotFoundException(inner) => inner.fmt(f), Error::StackSetNotEmptyException(inner) => inner.fmt(f), @@ -106,7 +129,9 @@ impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for Error { Self::AlreadyExistsException(inner) => inner.meta(), Self::CfnRegistryException(inner) => inner.meta(), Self::ChangeSetNotFoundException(inner) => inner.meta(), + Self::ConcurrentResourcesLimitExceededException(inner) => inner.meta(), Self::CreatedButModifiedException(inner) => inner.meta(), + Self::GeneratedTemplateNotFoundException(inner) => inner.meta(), Self::InsufficientCapabilitiesException(inner) => inner.meta(), Self::InvalidChangeSetStatusException(inner) => inner.meta(), Self::InvalidOperationException(inner) => inner.meta(), @@ -117,6 +142,9 @@ impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for Error { Self::OperationInProgressException(inner) => inner.meta(), Self::OperationNotFoundException(inner) => inner.meta(), Self::OperationStatusCheckFailedException(inner) => inner.meta(), + Self::ResourceScanInProgressException(inner) => inner.meta(), + Self::ResourceScanLimitExceededException(inner) => inner.meta(), + Self::ResourceScanNotFoundException(inner) => inner.meta(), Self::StackInstanceNotFoundException(inner) => inner.meta(), Self::StackNotFoundException(inner) => inner.meta(), Self::StackSetNotEmptyException(inner) => inner.meta(), @@ -296,6 +324,39 @@ impl FromThe resource with the name requested already exists.
+ AlreadyExistsException(crate::types::error::AlreadyExistsException), + ///No more than 5 generated templates can be in an InProgress
or Pending
status at one time. This error is also returned if a generated template that is in an InProgress
or Pending
status is attempted to be updated or deleted.
The quota for the resource has already been reached.
+ ///For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.
+ LimitExceededException(crate::types::error::LimitExceededException), + /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code). + #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \ + variable wildcard pattern and check `.code()`: + \ + `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }` + \ + See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-CreateGeneratedTemplateError) for what information is available for the error.")] + Unhandled(crate::error::sealed_unhandled::Unhandled), +} +impl CreateGeneratedTemplateError { + /// Creates the `CreateGeneratedTemplateError::Unhandled` variant from any error type. + pub fn unhandled( + err: impl ::std::convert::Into<::std::boxed::BoxAn optional list of resources to be included in the generated template.
+ ///If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate
API action.
The name assigned to the generated template.
+ pub generated_template_name: ::std::option::Option<::std::string::String>, + ///An optional name or ARN of a stack to use as the base stack for the generated template.
+ pub stack_name: ::std::option::Option<::std::string::String>, + ///The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
An optional list of resources to be included in the generated template.
+ ///If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate
API action.
The name assigned to the generated template.
+ pub fn generated_template_name(&self) -> ::std::option::Option<&str> { + self.generated_template_name.as_deref() + } + ///An optional name or ARN of a stack to use as the base stack for the generated template.
+ pub fn stack_name(&self) -> ::std::option::Option<&str> { + self.stack_name.as_deref() + } + ///The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
An optional list of resources to be included in the generated template.
+ ///If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate
API action.
An optional list of resources to be included in the generated template.
+ ///If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate
API action.
An optional list of resources to be included in the generated template.
+ ///If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate
API action.
The name assigned to the generated template.
+ /// This field is required. + pub fn generated_template_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self { + self.generated_template_name = ::std::option::Option::Some(input.into()); + self + } + ///The name assigned to the generated template.
+ pub fn set_generated_template_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self { + self.generated_template_name = input; + self + } + ///The name assigned to the generated template.
+ pub fn get_generated_template_name(&self) -> &::std::option::Option<::std::string::String> { + &self.generated_template_name + } + ///An optional name or ARN of a stack to use as the base stack for the generated template.
+ pub fn stack_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self { + self.stack_name = ::std::option::Option::Some(input.into()); + self + } + ///An optional name or ARN of a stack to use as the base stack for the generated template.
+ pub fn set_stack_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self { + self.stack_name = input; + self + } + ///An optional name or ARN of a stack to use as the base stack for the generated template.
+ pub fn get_stack_name(&self) -> &::std::option::Option<::std::string::String> { + &self.stack_name + } + ///The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The ID of the generated template.
+ pub generated_template_id: ::std::option::Option<::std::string::String>, + _request_id: OptionThe ID of the generated template.
+ pub fn generated_template_id(&self) -> ::std::option::Option<&str> { + self.generated_template_id.as_deref() + } +} +impl ::aws_types::request_id::RequestId for CreateGeneratedTemplateOutput { + fn request_id(&self) -> Option<&str> { + self._request_id.as_deref() + } +} +impl CreateGeneratedTemplateOutput { + /// Creates a new builder-style object to manufacture [`CreateGeneratedTemplateOutput`](crate::operation::create_generated_template::CreateGeneratedTemplateOutput). + pub fn builder() -> crate::operation::create_generated_template::builders::CreateGeneratedTemplateOutputBuilder { + crate::operation::create_generated_template::builders::CreateGeneratedTemplateOutputBuilder::default() + } +} + +/// A builder for [`CreateGeneratedTemplateOutput`](crate::operation::create_generated_template::CreateGeneratedTemplateOutput). +#[non_exhaustive] +#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)] +pub struct CreateGeneratedTemplateOutputBuilder { + pub(crate) generated_template_id: ::std::option::Option<::std::string::String>, + _request_id: OptionThe ID of the generated template.
+ pub fn generated_template_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self { + self.generated_template_id = ::std::option::Option::Some(input.into()); + self + } + ///The ID of the generated template.
+ pub fn set_generated_template_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self { + self.generated_template_id = input; + self + } + ///The ID of the generated template.
+ pub fn get_generated_template_id(&self) -> &::std::option::Option<::std::string::String> { + &self.generated_template_id + } + pub(crate) fn _request_id(mut self, request_id: impl IntoCreates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the DescribeGeneratedTemplate
API action.
An optional list of resources to be included in the generated template.
+ ///If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate
API action.
An optional list of resources to be included in the generated template.
+ ///If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate
API action.
An optional list of resources to be included in the generated template.
+ ///If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate
API action.
The name assigned to the generated template.
+ pub fn generated_template_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self { + self.inner = self.inner.generated_template_name(input.into()); + self + } + ///The name assigned to the generated template.
+ pub fn set_generated_template_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self { + self.inner = self.inner.set_generated_template_name(input); + self + } + ///The name assigned to the generated template.
+ pub fn get_generated_template_name(&self) -> &::std::option::Option<::std::string::String> { + self.inner.get_generated_template_name() + } + ///An optional name or ARN of a stack to use as the base stack for the generated template.
+ pub fn stack_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self { + self.inner = self.inner.stack_name(input.into()); + self + } + ///An optional name or ARN of a stack to use as the base stack for the generated template.
+ pub fn set_stack_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self { + self.inner = self.inner.set_stack_name(input); + self + } + ///An optional name or ARN of a stack to use as the base stack for the generated template.
+ pub fn get_stack_name(&self) -> &::std::option::Option<::std::string::String> { + self.inner.get_stack_name() + } + ///The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
pub rollback_configuration: ::std::option::OptionThe amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
pub notification_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>, @@ -129,7 +129,7 @@ impl CreateStackInput { pub fn rollback_configuration(&self) -> ::std::option::Option<&crate::types::RollbackConfiguration> { self.rollback_configuration.as_ref() } - ///The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
No more than 5 generated templates can be in an InProgress
or Pending
status at one time. This error is also returned if a generated template that is in an InProgress
or Pending
status is attempted to be updated or deleted.
The generated template was not found.
+ GeneratedTemplateNotFoundException(crate::types::error::GeneratedTemplateNotFoundException), + /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code). + #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \ + variable wildcard pattern and check `.code()`: + \ + `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }` + \ + See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DeleteGeneratedTemplateError) for what information is available for the error.")] + Unhandled(crate::error::sealed_unhandled::Unhandled), +} +impl DeleteGeneratedTemplateError { + /// Creates the `DeleteGeneratedTemplateError::Unhandled` variant from any error type. + pub fn unhandled( + err: impl ::std::convert::Into<::std::boxed::BoxThe name or Amazon Resource Name (ARN) of a generated template.
+ pub generated_template_name: ::std::option::Option<::std::string::String>, +} +impl DeleteGeneratedTemplateInput { + ///The name or Amazon Resource Name (ARN) of a generated template.
+ pub fn generated_template_name(&self) -> ::std::option::Option<&str> { + self.generated_template_name.as_deref() + } +} +impl DeleteGeneratedTemplateInput { + /// Creates a new builder-style object to manufacture [`DeleteGeneratedTemplateInput`](crate::operation::delete_generated_template::DeleteGeneratedTemplateInput). + pub fn builder() -> crate::operation::delete_generated_template::builders::DeleteGeneratedTemplateInputBuilder { + crate::operation::delete_generated_template::builders::DeleteGeneratedTemplateInputBuilder::default() + } +} + +/// A builder for [`DeleteGeneratedTemplateInput`](crate::operation::delete_generated_template::DeleteGeneratedTemplateInput). +#[non_exhaustive] +#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)] +pub struct DeleteGeneratedTemplateInputBuilder { + pub(crate) generated_template_name: ::std::option::Option<::std::string::String>, +} +impl DeleteGeneratedTemplateInputBuilder { + ///The name or Amazon Resource Name (ARN) of a generated template.
+ /// This field is required. + pub fn generated_template_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self { + self.generated_template_name = ::std::option::Option::Some(input.into()); + self + } + ///The name or Amazon Resource Name (ARN) of a generated template.
+ pub fn set_generated_template_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self { + self.generated_template_name = input; + self + } + ///The name or Amazon Resource Name (ARN) of a generated template.
+ pub fn get_generated_template_name(&self) -> &::std::option::Option<::std::string::String> { + &self.generated_template_name + } + /// Consumes the builder and constructs a [`DeleteGeneratedTemplateInput`](crate::operation::delete_generated_template::DeleteGeneratedTemplateInput). + pub fn build( + self, + ) -> ::std::result::Result< + crate::operation::delete_generated_template::DeleteGeneratedTemplateInput, + ::aws_smithy_types::error::operation::BuildError, + > { + ::std::result::Result::Ok(crate::operation::delete_generated_template::DeleteGeneratedTemplateInput { + generated_template_name: self.generated_template_name, + }) + } +} diff --git a/sdk/cloudformation/src/operation/delete_generated_template/_delete_generated_template_output.rs b/sdk/cloudformation/src/operation/delete_generated_template/_delete_generated_template_output.rs new file mode 100644 index 000000000000..dd53b22cddd2 --- /dev/null +++ b/sdk/cloudformation/src/operation/delete_generated_template/_delete_generated_template_output.rs @@ -0,0 +1,42 @@ +// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT. +#[allow(missing_docs)] // documentation missing in model +#[non_exhaustive] +#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)] +pub struct DeleteGeneratedTemplateOutput { + _request_id: OptionDeleted a generated template.
+#[derive(::std::clone::Clone, ::std::fmt::Debug)] +pub struct DeleteGeneratedTemplateFluentBuilder { + handle: ::std::sync::ArcThe name or Amazon Resource Name (ARN) of a generated template.
+ pub fn generated_template_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self { + self.inner = self.inner.generated_template_name(input.into()); + self + } + ///The name or Amazon Resource Name (ARN) of a generated template.
+ pub fn set_generated_template_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self { + self.inner = self.inner.set_generated_template_name(input); + self + } + ///The name or Amazon Resource Name (ARN) of a generated template.
+ pub fn get_generated_template_name(&self) -> &::std::option::Option<::std::string::String> { + self.inner.get_generated_template_name() + } +} diff --git a/sdk/cloudformation/src/operation/describe_generated_template.rs b/sdk/cloudformation/src/operation/describe_generated_template.rs new file mode 100644 index 000000000000..e61a7bd7f0e7 --- /dev/null +++ b/sdk/cloudformation/src/operation/describe_generated_template.rs @@ -0,0 +1,363 @@ +// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT. +/// Orchestration and serialization glue logic for `DescribeGeneratedTemplate`. +#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)] +#[non_exhaustive] +pub struct DescribeGeneratedTemplate; +impl DescribeGeneratedTemplate { + /// Creates a new `DescribeGeneratedTemplate` + pub fn new() -> Self { + Self + } + pub(crate) async fn orchestrate( + runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins, + input: crate::operation::describe_generated_template::DescribeGeneratedTemplateInput, + ) -> ::std::result::Result< + crate::operation::describe_generated_template::DescribeGeneratedTemplateOutput, + ::aws_smithy_runtime_api::client::result::SdkError< + crate::operation::describe_generated_template::DescribeGeneratedTemplateError, + ::aws_smithy_runtime_api::client::orchestrator::HttpResponse, + >, + > { + let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError< + ::aws_smithy_runtime_api::client::interceptors::context::Error, + ::aws_smithy_runtime_api::client::orchestrator::HttpResponse, + >| { + err.map_service_error(|err| { + err.downcast::The generated template was not found.
+ GeneratedTemplateNotFoundException(crate::types::error::GeneratedTemplateNotFoundException), + /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code). + #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \ + variable wildcard pattern and check `.code()`: + \ + `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }` + \ + See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeGeneratedTemplateError) for what information is available for the error.")] + Unhandled(crate::error::sealed_unhandled::Unhandled), +} +impl DescribeGeneratedTemplateError { + /// Creates the `DescribeGeneratedTemplateError::Unhandled` variant from any error type. + pub fn unhandled( + err: impl ::std::convert::Into<::std::boxed::BoxThe name or Amazon Resource Name (ARN) of a generated template.
+ pub generated_template_name: ::std::option::Option<::std::string::String>, +} +impl DescribeGeneratedTemplateInput { + ///The name or Amazon Resource Name (ARN) of a generated template.
+ pub fn generated_template_name(&self) -> ::std::option::Option<&str> { + self.generated_template_name.as_deref() + } +} +impl DescribeGeneratedTemplateInput { + /// Creates a new builder-style object to manufacture [`DescribeGeneratedTemplateInput`](crate::operation::describe_generated_template::DescribeGeneratedTemplateInput). + pub fn builder() -> crate::operation::describe_generated_template::builders::DescribeGeneratedTemplateInputBuilder { + crate::operation::describe_generated_template::builders::DescribeGeneratedTemplateInputBuilder::default() + } +} + +/// A builder for [`DescribeGeneratedTemplateInput`](crate::operation::describe_generated_template::DescribeGeneratedTemplateInput). +#[non_exhaustive] +#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)] +pub struct DescribeGeneratedTemplateInputBuilder { + pub(crate) generated_template_name: ::std::option::Option<::std::string::String>, +} +impl DescribeGeneratedTemplateInputBuilder { + ///The name or Amazon Resource Name (ARN) of a generated template.
+ /// This field is required. + pub fn generated_template_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self { + self.generated_template_name = ::std::option::Option::Some(input.into()); + self + } + ///The name or Amazon Resource Name (ARN) of a generated template.
+ pub fn set_generated_template_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self { + self.generated_template_name = input; + self + } + ///The name or Amazon Resource Name (ARN) of a generated template.
+ pub fn get_generated_template_name(&self) -> &::std::option::Option<::std::string::String> { + &self.generated_template_name + } + /// Consumes the builder and constructs a [`DescribeGeneratedTemplateInput`](crate::operation::describe_generated_template::DescribeGeneratedTemplateInput). + pub fn build( + self, + ) -> ::std::result::Result< + crate::operation::describe_generated_template::DescribeGeneratedTemplateInput, + ::aws_smithy_types::error::operation::BuildError, + > { + ::std::result::Result::Ok(crate::operation::describe_generated_template::DescribeGeneratedTemplateInput { + generated_template_name: self.generated_template_name, + }) + } +} diff --git a/sdk/cloudformation/src/operation/describe_generated_template/_describe_generated_template_output.rs b/sdk/cloudformation/src/operation/describe_generated_template/_describe_generated_template_output.rs new file mode 100644 index 000000000000..da9be8c1fbb0 --- /dev/null +++ b/sdk/cloudformation/src/operation/describe_generated_template/_describe_generated_template_output.rs @@ -0,0 +1,384 @@ +// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT. +#[allow(missing_docs)] // documentation missing in model +#[non_exhaustive] +#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)] +pub struct DescribeGeneratedTemplateOutput { + ///The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}
. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
.
The name of the generated template.
+ pub generated_template_name: ::std::option::Option<::std::string::String>, + ///A list of objects describing the details of the resources in the template generation.
+ pub resources: ::std::option::Option<::std::vec::VecThe status of the template generation. Supported values are:
+ ///CreatePending
- the creation of the template is pending.
CreateInProgress
- the creation of the template is in progress.
DeletePending
- the deletion of the template is pending.
DeleteInProgress
- the deletion of the template is in progress.
UpdatePending
- the update of the template is pending.
UpdateInProgress
- the update of the template is in progress.
Failed
- the template operation failed.
Complete
- the template operation is complete.
The reason for the current template generation status. This will provide more details if a failure happened.
+ pub status_reason: ::std::option::Option<::std::string::String>, + ///The time the generated template was created.
+ pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>, + ///The time the generated template was last updated.
+ pub last_updated_time: ::std::option::Option<::aws_smithy_types::DateTime>, + ///An object describing the progress of the template generation.
+ pub progress: ::std::option::OptionThe stack ARN of the base stack if a base stack was provided when generating the template.
+ pub stack_id: ::std::option::Option<::std::string::String>, + ///The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
+ pub total_warnings: ::std::option::OptionThe Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}
. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
.
The name of the generated template.
+ pub fn generated_template_name(&self) -> ::std::option::Option<&str> { + self.generated_template_name.as_deref() + } + ///A list of objects describing the details of the resources in the template generation.
+ /// + /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.resources.is_none()`. + pub fn resources(&self) -> &[crate::types::ResourceDetail] { + self.resources.as_deref().unwrap_or_default() + } + ///The status of the template generation. Supported values are:
+ ///CreatePending
- the creation of the template is pending.
CreateInProgress
- the creation of the template is in progress.
DeletePending
- the deletion of the template is pending.
DeleteInProgress
- the deletion of the template is in progress.
UpdatePending
- the update of the template is pending.
UpdateInProgress
- the update of the template is in progress.
Failed
- the template operation failed.
Complete
- the template operation is complete.
The reason for the current template generation status. This will provide more details if a failure happened.
+ pub fn status_reason(&self) -> ::std::option::Option<&str> { + self.status_reason.as_deref() + } + ///The time the generated template was created.
+ pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> { + self.creation_time.as_ref() + } + ///The time the generated template was last updated.
+ pub fn last_updated_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> { + self.last_updated_time.as_ref() + } + ///An object describing the progress of the template generation.
+ pub fn progress(&self) -> ::std::option::Option<&crate::types::TemplateProgress> { + self.progress.as_ref() + } + ///The stack ARN of the base stack if a base stack was provided when generating the template.
+ pub fn stack_id(&self) -> ::std::option::Option<&str> { + self.stack_id.as_deref() + } + ///The configuration details of the generated template, including the DeletionPolicy
and UpdateReplacePolicy
.
The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
+ pub fn total_warnings(&self) -> ::std::option::Option