Package software.amazon.awssdk.services.cloudformation.model

Interface CreateStackRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateStackRequest.Builder,CreateStackRequest>, SdkBuilder<CreateStackRequest.Builder,CreateStackRequest>

Enclosing class:

CreateStackRequest

public static interface CreateStackRequest.Builder
extends CopyableBuilder<CreateStackRequest.Builder,CreateStackRequest>

Method Summary

Modifier and Type	Method	Description
CreateStackRequest.Builder	capabilities(String... capabilities)	A list of values that you must specify before AWS CloudFormation can create certain stacks.
CreateStackRequest.Builder	capabilities(Collection<String> capabilities)	A list of values that you must specify before AWS CloudFormation can create certain stacks.
CreateStackRequest.Builder	capabilities(Capability... capabilities)	A list of values that you must specify before AWS CloudFormation can create certain stacks.
CreateStackRequest.Builder	clientRequestToken(String clientRequestToken)	A unique identifier for this CreateStack request.
CreateStackRequest.Builder	disableRollback(Boolean disableRollback)	Set to true to disable rollback of the stack if stack creation failed.
CreateStackRequest.Builder	notificationARNs(String... notificationARNs)	The Simple Notification Service (SNS) topic ARNs to publish stack related events.
CreateStackRequest.Builder	notificationARNs(Collection<String> notificationARNs)	The Simple Notification Service (SNS) topic ARNs to publish stack related events.
CreateStackRequest.Builder	onFailure(String onFailure)	Determines what action will be taken if stack creation fails.
CreateStackRequest.Builder	onFailure(OnFailure onFailure)	Determines what action will be taken if stack creation fails.
CreateStackRequest.Builder	parameters(Collection<Parameter> parameters)	A list of Parameter structures that specify input parameters for the stack.
CreateStackRequest.Builder	parameters(Parameter... parameters)	A list of Parameter structures that specify input parameters for the stack.
CreateStackRequest.Builder	resourceTypes(String... resourceTypes)	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.
CreateStackRequest.Builder	resourceTypes(Collection<String> resourceTypes)	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.
CreateStackRequest.Builder	roleARN(String roleARN)	The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack.
CreateStackRequest.Builder	stackName(String stackName)	The name that is associated with the stack.
CreateStackRequest.Builder	stackPolicyBody(String stackPolicyBody)	Structure containing the stack policy body.
CreateStackRequest.Builder	stackPolicyURL(String stackPolicyURL)	Location of a file containing the stack policy.
CreateStackRequest.Builder	tags(Collection<Tag> tags)	Key-value pairs to associate with this stack.
CreateStackRequest.Builder	tags(Tag... tags)	Key-value pairs to associate with this stack.
CreateStackRequest.Builder	templateBody(String templateBody)	Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
CreateStackRequest.Builder	templateURL(String templateURL)	Location of file containing the template body.
CreateStackRequest.Builder	timeoutInMinutes(Integer timeoutInMinutes)	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.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

stackName

CreateStackRequest.Builder stackName(String stackName)

The 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.

Parameters:

stackName - The 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

templateBody

CreateStackRequest.Builder templateBody(String templateBody)

Structure 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 in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Parameters:

templateBody - Structure 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 in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

templateURL

CreateStackRequest.Builder templateURL(String templateURL)

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Parameters:

templateURL - Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameters

CreateStackRequest.Builder parameters(Collection<Parameter> parameters)

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

Parameters:

parameters - A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameters

CreateStackRequest.Builder parameters(Parameter... parameters)

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

NOTE: This method appends the values to the existing list (if any). Use #setParameters(java.util.Collection) or #withParameters(java.util.Collection) if you want to override the existing values.

Parameters:

parameters - A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

Returns:

Returns a reference to this object so that method calls can be chained together.

disableRollback

CreateStackRequest.Builder disableRollback(Boolean disableRollback)

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

Parameters:

disableRollback - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

timeoutInMinutes

CreateStackRequest.Builder timeoutInMinutes(Integer timeoutInMinutes)

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.

Parameters:

timeoutInMinutes - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationARNs

CreateStackRequest.Builder notificationARNs(Collection<String> notificationARNs)

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).

Parameters:

notificationARNs - 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).

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationARNs

CreateStackRequest.Builder notificationARNs(String... notificationARNs)

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).

NOTE: This method appends the values to the existing list (if any). Use #setNotificationARNs(java.util.Collection) or #withNotificationARNs(java.util.Collection) if you want to override the existing values.

Parameters:

notificationARNs - 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).

Returns:

Returns a reference to this object so that method calls can be chained together.

capabilities

CreateStackRequest.Builder capabilities(Collection<String> capabilities)

A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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 this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Parameters:

capabilities - A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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 this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Capability

capabilities

CreateStackRequest.Builder capabilities(String... capabilities)

A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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 this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

NOTE: This method appends the values to the existing list (if any). Use #setCapabilities(java.util.Collection) or #withCapabilities(java.util.Collection) if you want to override the existing values.

Parameters:

capabilities - A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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 this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Capability

capabilities

CreateStackRequest.Builder capabilities(Capability... capabilities)

A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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 this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

NOTE: This method appends the values to the existing list (if any). Use #setCapabilities(java.util.Collection) or #withCapabilities(java.util.Collection) if you want to override the existing values.

Parameters:

capabilities - A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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 this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Capability

resourceTypes

CreateStackRequest.Builder resourceTypes(Collection<String> resourceTypes)

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.

Parameters:

resourceTypes - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceTypes

CreateStackRequest.Builder resourceTypes(String... resourceTypes)

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.

NOTE: This method appends the values to the existing list (if any). Use #setResourceTypes(java.util.Collection) or #withResourceTypes(java.util.Collection) if you want to override the existing values.

Parameters:

resourceTypes - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleARN

CreateStackRequest.Builder roleARN(String roleARN)

The 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.

Parameters:

roleARN - The 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

onFailure

CreateStackRequest.Builder onFailure(String onFailure)

Determines 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

Parameters:

onFailure - Determines 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OnFailure

onFailure

CreateStackRequest.Builder onFailure(OnFailure onFailure)

Determines 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

Parameters:

onFailure - Determines 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OnFailure

stackPolicyBody

CreateStackRequest.Builder stackPolicyBody(String stackPolicyBody)

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Parameters:

stackPolicyBody - Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

stackPolicyURL

CreateStackRequest.Builder stackPolicyURL(String stackPolicyURL)

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Parameters:

stackPolicyURL - Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateStackRequest.Builder tags(Collection<Tag> tags)

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 10 tags can be specified.

Parameters:

tags - 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 10 tags can be specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateStackRequest.Builder tags(Tag... tags)

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 10 tags can be specified.

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - 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 10 tags can be specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientRequestToken

CreateStackRequest.Builder clientRequestToken(String clientRequestToken)

A 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.

Parameters:

clientRequestToken - A 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.

Returns:

Returns a reference to this object so that method calls can be chained together.