software.amazon.awssdk.services.serverlessapplicationrepository.model

Class CreateCloudFormationChangeSetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.serverlessapplicationrepository.model.ServerlessApplicationRepositoryRequest

software.amazon.awssdk.services.serverlessapplicationrepository.model.CreateCloudFormationChangeSetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCloudFormationChangeSetRequest.Builder,CreateCloudFormationChangeSetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateCloudFormationChangeSetRequest
extends ServerlessApplicationRepositoryRequest
implements ToCopyableBuilder<CreateCloudFormationChangeSetRequest.Builder,CreateCloudFormationChangeSetRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCloudFormationChangeSetRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationId() The Amazon Resource Name (ARN) of the application.
static CreateCloudFormationChangeSetRequest.Builder	builder()
List<String>	capabilities() A list of values that you must specify before you can deploy certain applications.
String	changeSetName() This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
String	clientToken() This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
String	description() This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<String>	notificationArns() This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
List<ParameterValue>	parameterOverrides() A list of parameter values for the parameters of the application.
List<String>	resourceTypes() This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
RollbackConfiguration	rollbackConfiguration() This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
List<SdkField<?>>	sdkFields()
String	semanticVersion() The semantic version of the application:
static Class<? extends CreateCloudFormationChangeSetRequest.Builder>	serializableBuilderClass()
String	stackName() This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
List<Tag>	tags() This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
String	templateId() The UUID returned by CreateCloudFormationTemplate.
CreateCloudFormationChangeSetRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

applicationId

public String applicationId()

The Amazon Resource Name (ARN) of the application.

Returns:

The Amazon Resource Name (ARN) of the application.

capabilities

public List<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, and CAPABILITY_RESOURCE_POLICY.

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.

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.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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, and CAPABILITY_RESOURCE_POLICY.

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.

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.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

changeSetName

public String changeSetName()

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

Returns:

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

clientToken

public String clientToken()

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

Returns:

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

description

public String description()

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

Returns:

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

notificationArns

public List<String> notificationArns()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

parameterOverrides

public List<ParameterValue> parameterOverrides()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

resourceTypes

public List<String> resourceTypes()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

rollbackConfiguration

public RollbackConfiguration rollbackConfiguration()

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

Returns:

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

semanticVersion

public String semanticVersion()

The semantic version of the application:

https://semver.org/

Returns:

The semantic version of the application:

https://semver.org/

stackName

public String stackName()

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

Returns:

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

tags

public List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

templateId

public 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}

Returns:

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}

toBuilder

public CreateCloudFormationChangeSetRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCloudFormationChangeSetRequest.Builder,CreateCloudFormationChangeSetRequest>

Specified by:

toBuilder in class ServerlessApplicationRepositoryRequest

Returns:

a builder for type T

builder

public static CreateCloudFormationChangeSetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCloudFormationChangeSetRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.