![]() |
![]()
| ![]() |
![]()
NAMEPaws::CloudFormation::CreateChangeSet - Arguments for method CreateChangeSet on Paws::CloudFormation DESCRIPTIONThis class represents the parameters used for calling the method CreateChangeSet on the AWS CloudFormation service. Use the attributes of this class as arguments to method CreateChangeSet. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateChangeSet. SYNOPSISmy $cloudformation = Paws->service('CloudFormation'); my $CreateChangeSetOutput = $cloudformation->CreateChangeSet( ChangeSetName => 'MyChangeSetName', StackName => 'MyStackNameOrId', Capabilities => [ 'CAPABILITY_IAM', ... # values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND ], # OPTIONAL ChangeSetType => 'CREATE', # OPTIONAL ClientToken => 'MyClientToken', # OPTIONAL Description => 'MyDescription', # OPTIONAL IncludeNestedStacks => 1, # OPTIONAL NotificationARNs => [ 'MyNotificationARN', ... ], # OPTIONAL Parameters => [ { ParameterKey => 'MyParameterKey', # OPTIONAL ParameterValue => 'MyParameterValue', # OPTIONAL ResolvedValue => 'MyParameterValue', # OPTIONAL UsePreviousValue => 1, # OPTIONAL }, ... ], # OPTIONAL ResourceTypes => [ 'MyResourceType', ... # min: 1, max: 256 ], # OPTIONAL ResourcesToImport => [ { LogicalResourceId => 'MyLogicalResourceId', ResourceIdentifier => { 'MyResourceIdentifierPropertyKey' => 'MyResourceIdentifierPropertyValue' , # key: min: 1, max: 2048, value: min: 1, max: 2048 }, # min: 1, max: 256 ResourceType => 'MyResourceType', # min: 1, max: 256 }, ... ], # OPTIONAL RoleARN => 'MyRoleARN', # OPTIONAL RollbackConfiguration => { MonitoringTimeInMinutes => 1, # max: 180; OPTIONAL RollbackTriggers => [ { Arn => 'MyArn', Type => 'MyType', }, ... ], # max: 5; OPTIONAL }, # OPTIONAL Tags => [ { Key => 'MyTagKey', # min: 1, max: 128 Value => 'MyTagValue', # min: 1, max: 256 }, ... ], # OPTIONAL TemplateBody => 'MyTemplateBody', # OPTIONAL TemplateURL => 'MyTemplateURL', # OPTIONAL UsePreviousTemplate => 1, # OPTIONAL ); # Results: my $Id = $CreateChangeSetOutput->Id; my $StackId = $CreateChangeSetOutput->StackId; # Returns a L<Paws::CloudFormation::CreateChangeSetOutput> object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/cloudformation/CreateChangeSet> ATTRIBUTESCapabilities => ArrayRef[Str|Undef]In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
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 AWS CloudFormation Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
REQUIRED ChangeSetName => StrThe name of the change set. The name must be unique among all change sets that are associated with the specified stack. A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters. ChangeSetType => StrThe type of change set operation. To create a change set for a new stack, specify "CREATE". To create a change set for an existing stack, specify "UPDATE". To create a change set for an import operation, specify "IMPORT". If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the "REVIEW_IN_PROGRESS" (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995) state until you execute the change set. By default, AWS CloudFormation specifies "UPDATE". You can't use the "UPDATE" type to create a change set for a new stack or the "CREATE" type to create a change set for an existing stack. Valid values are: "CREATE", "UPDATE", "IMPORT" ClientToken => StrA unique identifier for this "CreateChangeSet" request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry "CreateChangeSet" requests to ensure that AWS CloudFormation successfully received them. Description => StrA description to help you identify this change set. IncludeNestedStacks => BoolCreates a change set for the all nested stacks specified in the template. The default behavior of this action is set to "False". To include nested sets in a change set, specify "True". NotificationARNs => ArrayRef[Str|Undef]The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list. Parameters => ArrayRef[Paws::CloudFormation::Parameter]A list of "Parameter" structures that specify input parameters for the change set. For more information, see the Parameter data type. ResourcesToImport => ArrayRef[Paws::CloudFormation::ResourceToImport]The resources to import into your stack. ResourceTypes => ArrayRef[Str|Undef]The template resource types that you have permissions to work with if you execute this change set, such as "AWS::EC2::Instance", "AWS::EC2::*", or "Custom::MyCustomInstance". If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) in the AWS CloudFormation User Guide. RoleARN => StrThe Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials. RollbackConfiguration => Paws::CloudFormation::RollbackConfigurationThe rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. REQUIRED StackName => StrThe name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values. Tags => ArrayRef[Paws::CloudFormation::Tag]Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags. TemplateBody => StrA structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified. Conditional: You must specify only "TemplateBody" or "TemplateURL". TemplateURL => StrThe location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager document. AWS CloudFormation generates the change set by comparing this template with the stack that you specified. Conditional: You must specify only "TemplateBody" or "TemplateURL". UsePreviousTemplate => BoolWhether to reuse the template that is associated with the stack to create the change set. SEE ALSOThis class forms part of Paws, documenting arguments for method CreateChangeSet in Paws::CloudFormation BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|