Package software.amazon.awssdk.services.serverlessapplicationrepository.model

Interface CreateCloudFormationChangeSetRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateCloudFormationChangeSetRequest.Builder,CreateCloudFormationChangeSetRequest>, SdkBuilder<CreateCloudFormationChangeSetRequest.Builder,CreateCloudFormationChangeSetRequest>, SdkPojo, SdkRequest.Builder, ServerlessApplicationRepositoryRequest.Builder

Enclosing class:

CreateCloudFormationChangeSetRequest

public static interface CreateCloudFormationChangeSetRequest.Builder
extends ServerlessApplicationRepositoryRequest.Builder, SdkPojo, CopyableBuilder<CreateCloudFormationChangeSetRequest.Builder,CreateCloudFormationChangeSetRequest>

Method Summary

Modifier and Type	Method	Description
CreateCloudFormationChangeSetRequest.Builder	applicationId(String applicationId)	The Amazon Resource Name (ARN) of the application.
CreateCloudFormationChangeSetRequest.Builder	capabilities(String... capabilities)	A list of values that you must specify before you can deploy certain applications.
CreateCloudFormationChangeSetRequest.Builder	capabilities(Collection<String> capabilities)	A list of values that you must specify before you can deploy certain applications.
CreateCloudFormationChangeSetRequest.Builder	changeSetName(String changeSetName)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	clientToken(String clientToken)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	description(String description)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	notificationArns(String... notificationArns)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	notificationArns(Collection<String> notificationArns)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateCloudFormationChangeSetRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateCloudFormationChangeSetRequest.Builder	parameterOverrides(Collection<ParameterValue> parameterOverrides)	A list of parameter values for the parameters of the application.
CreateCloudFormationChangeSetRequest.Builder	parameterOverrides(Consumer<ParameterValue.Builder>... parameterOverrides)	A list of parameter values for the parameters of the application.
CreateCloudFormationChangeSetRequest.Builder	parameterOverrides(ParameterValue... parameterOverrides)	A list of parameter values for the parameters of the application.
CreateCloudFormationChangeSetRequest.Builder	resourceTypes(String... resourceTypes)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	resourceTypes(Collection<String> resourceTypes)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
default CreateCloudFormationChangeSetRequest.Builder	rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	rollbackConfiguration(RollbackConfiguration rollbackConfiguration)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	semanticVersion(String semanticVersion)	The semantic version of the application:
CreateCloudFormationChangeSetRequest.Builder	stackName(String stackName)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	tags(Collection<Tag> tags)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	tags(Consumer<Tag.Builder>... tags)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	tags(Tag... tags)	This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
CreateCloudFormationChangeSetRequest.Builder	templateId(String templateId)	The UUID returned by CreateCloudFormationTemplate.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.services.serverlessapplicationrepository.model.ServerlessApplicationRepositoryRequest.Builder

build

Method Details

applicationId

CreateCloudFormationChangeSetRequest.Builder applicationId(String applicationId)

The Amazon Resource Name (ARN) of the application.

Parameters:

applicationId - The Amazon Resource Name (ARN) of the application.

Returns:

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

capabilities

CreateCloudFormationChangeSetRequest.Builder capabilities(Collection<String> capabilities)

A list of values that you must specify before you can deploy certain applications. Some applications 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 applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Parameters:

capabilities - A list of values that you must specify before you can deploy certain applications. Some applications 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 applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Returns:

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

capabilities

CreateCloudFormationChangeSetRequest.Builder capabilities(String... capabilities)

A list of values that you must specify before you can deploy certain applications. Some applications 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 applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Parameters:

capabilities - A list of values that you must specify before you can deploy certain applications. Some applications 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 applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Returns:

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

changeSetName

CreateCloudFormationChangeSetRequest.Builder changeSetName(String changeSetName)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

changeSetName - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

clientToken

CreateCloudFormationChangeSetRequest.Builder clientToken(String clientToken)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

clientToken - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

description

CreateCloudFormationChangeSetRequest.Builder description(String description)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

description - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

notificationArns

CreateCloudFormationChangeSetRequest.Builder notificationArns(Collection<String> notificationArns)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

notificationArns - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

notificationArns

CreateCloudFormationChangeSetRequest.Builder notificationArns(String... notificationArns)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

notificationArns - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

parameterOverrides

CreateCloudFormationChangeSetRequest.Builder parameterOverrides(Collection<ParameterValue> parameterOverrides)

A list of parameter values for the parameters of the application.

Parameters:

parameterOverrides - A list of parameter values for the parameters of the application.

Returns:

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

parameterOverrides

CreateCloudFormationChangeSetRequest.Builder parameterOverrides(ParameterValue... parameterOverrides)

A list of parameter values for the parameters of the application.

Parameters:

parameterOverrides - A list of parameter values for the parameters of the application.

Returns:

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

parameterOverrides

CreateCloudFormationChangeSetRequest.Builder parameterOverrides(Consumer<ParameterValue.Builder>... parameterOverrides)

A list of parameter values for the parameters of the application.

This is a convenience method that creates an instance of the ParameterValue.Builder avoiding the need to create one manually via ParameterValue.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameterOverrides(List<ParameterValue>).

Parameters:

parameterOverrides - a consumer that will call methods on ParameterValue.Builder

Returns:

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

See Also:

• parameterOverrides(java.util.Collection<ParameterValue>)

resourceTypes

CreateCloudFormationChangeSetRequest.Builder resourceTypes(Collection<String> resourceTypes)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

resourceTypes - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

resourceTypes

CreateCloudFormationChangeSetRequest.Builder resourceTypes(String... resourceTypes)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

resourceTypes - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

rollbackConfiguration

CreateCloudFormationChangeSetRequest.Builder rollbackConfiguration(RollbackConfiguration rollbackConfiguration)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

rollbackConfiguration - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

rollbackConfiguration

default CreateCloudFormationChangeSetRequest.Builder rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

This is a convenience method that creates an instance of the RollbackConfiguration.Builder avoiding the need to create one manually via RollbackConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rollbackConfiguration(RollbackConfiguration).

Parameters:

rollbackConfiguration - a consumer that will call methods on RollbackConfiguration.Builder

Returns:

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

See Also:

• rollbackConfiguration(RollbackConfiguration)

semanticVersion

CreateCloudFormationChangeSetRequest.Builder semanticVersion(String semanticVersion)

The semantic version of the application:

https://semver.org/

Parameters:

semanticVersion - The semantic version of the application:

https://semver.org/

Returns:

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

stackName

CreateCloudFormationChangeSetRequest.Builder stackName(String stackName)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

stackName - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

tags

CreateCloudFormationChangeSetRequest.Builder tags(Collection<Tag> tags)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

tags - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

tags

CreateCloudFormationChangeSetRequest.Builder tags(Tag... tags)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Parameters:

tags - This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Returns:

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

tags

CreateCloudFormationChangeSetRequest.Builder tags(Consumer<Tag.Builder>... tags)

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

templateId

CreateCloudFormationChangeSetRequest.Builder templateId(String templateId)

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

Parameters:

templateId - The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

Returns:

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

overrideConfiguration

CreateCloudFormationChangeSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateCloudFormationChangeSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.