![]() |
![]()
| ![]() |
![]()
NAMEPaws::CloudFormation::CreateStack - Arguments for method CreateStack on Paws::CloudFormation DESCRIPTIONThis class represents the parameters used for calling the method CreateStack on the AWS CloudFormation service. Use the attributes of this class as arguments to method CreateStack. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateStack. SYNOPSISmy $cloudformation = Paws->service('CloudFormation'); my $CreateStackOutput = $cloudformation->CreateStack( StackName => 'MyStackName', Capabilities => [ 'CAPABILITY_IAM', ... # values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND ], # OPTIONAL ClientRequestToken => 'MyClientRequestToken', # OPTIONAL DisableRollback => 1, # OPTIONAL EnableTerminationProtection => 1, # OPTIONAL NotificationARNs => [ 'MyNotificationARN', ... ], # OPTIONAL OnFailure => 'DO_NOTHING', # OPTIONAL Parameters => [ { ParameterKey => 'MyParameterKey', # OPTIONAL ParameterValue => 'MyParameterValue', # OPTIONAL ResolvedValue => 'MyParameterValue', # OPTIONAL UsePreviousValue => 1, # OPTIONAL }, ... ], # OPTIONAL ResourceTypes => [ 'MyResourceType', ... # min: 1, max: 256 ], # OPTIONAL RoleARN => 'MyRoleARN', # OPTIONAL RollbackConfiguration => { MonitoringTimeInMinutes => 1, # max: 180; OPTIONAL RollbackTriggers => [ { Arn => 'MyArn', Type => 'MyType', }, ... ], # max: 5; OPTIONAL }, # OPTIONAL StackPolicyBody => 'MyStackPolicyBody', # OPTIONAL StackPolicyURL => 'MyStackPolicyURL', # OPTIONAL Tags => [ { Key => 'MyTagKey', # min: 1, max: 128 Value => 'MyTagValue', # min: 1, max: 256 }, ... ], # OPTIONAL TemplateBody => 'MyTemplateBody', # OPTIONAL TemplateURL => 'MyTemplateURL', # OPTIONAL TimeoutInMinutes => 1, # OPTIONAL ); # Results: my $StackId = $CreateStackOutput->StackId; # Returns a L<Paws::CloudFormation::CreateStackOutput> 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/CreateStack> 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).
ClientRequestToken => StrA unique identifier for this "CreateStack" request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry "CreateStack" requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a "CreateStack" operation with the token "token1", then all the "StackEvents" generated by that operation will have "ClientRequestToken" set as "token1". In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: "Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002". DisableRollback => BoolSet to "true" to disable rollback of the stack if stack creation failed. You can specify either "DisableRollback" or "OnFailure", but not both. Default: "false" EnableTerminationProtection => BoolWhether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default. For nested stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), termination protection is set on the root stack and cannot be changed directly on the nested stack. NotificationARNs => ArrayRef[Str|Undef]The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI). OnFailure => StrDetermines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either "OnFailure" or "DisableRollback", but not both. Default: "ROLLBACK" Valid values are: "DO_NOTHING", "ROLLBACK", "DELETE" Parameters => ArrayRef[Paws::CloudFormation::Parameter]A list of "Parameter" structures that specify input parameters for the stack. For more information, see the Parameter (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) data type. ResourceTypes => ArrayRef[Str|Undef]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 AWS resource), "Custom::*" (for all custom resources), "Custom::logical_ID " (for a specific custom resource), "AWS::service_name::*" (for all resources of a particular AWS service), and "AWS::service_name::resource_logical_ID " (for a specific AWS resource). If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). RoleARN => StrThe Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always 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 that is associated with the stack. The name must be unique in the Region in which you are creating the stack. A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters. StackPolicyBody => StrStructure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) in the AWS CloudFormation User Guide. You can specify either the "StackPolicyBody" or the "StackPolicyURL" parameter, but not both. StackPolicyURL => StrLocation of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the "StackPolicyBody" or the "StackPolicyURL" parameter, but not both. Tags => ArrayRef[Paws::CloudFormation::Tag]Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified. TemplateBody => StrStructure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) in the AWS CloudFormation User Guide. Conditional: You must specify either the "TemplateBody" or the "TemplateURL" parameter, but not both. TemplateURL => StrLocation of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) in the AWS CloudFormation User Guide. Conditional: You must specify either the "TemplateBody" or the "TemplateURL" parameter, but not both. TimeoutInMinutes => IntThe 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. SEE ALSOThis class forms part of Paws, documenting arguments for method CreateStack 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>
|