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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCapabilities() Returns true if the Capabilities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasNotificationArns() Returns true if the NotificationArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasParameterOverrides() Returns true if the ParameterOverrides property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasResourceTypes() Returns true if the ResourceTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

applicationId

public final String applicationId()

The Amazon Resource Name (ARN) of the application.

Returns:

The Amazon Resource Name (ARN) of the application.

hasCapabilities

public final boolean hasCapabilities()

Returns true if the Capabilities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

capabilities

public final 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, 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.

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

You can use hasCapabilities() to see if a value was sent in this field.

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

changeSetName

public final 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 final 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 final 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.

hasNotificationArns

public final boolean hasNotificationArns()

Returns true if the NotificationArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

notificationArns

public final 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.

You can use hasNotificationArns() to see if a value was sent in this field.

Returns:

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

hasParameterOverrides

public final boolean hasParameterOverrides()

Returns true if the ParameterOverrides property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

parameterOverrides

public final 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.

You can use hasParameterOverrides() to see if a value was sent in this field.

Returns:

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

hasResourceTypes

public final boolean hasResourceTypes()

Returns true if the ResourceTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

resourceTypes

public final 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.

You can use hasResourceTypes() to see if a value was sent in this field.

Returns:

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

rollbackConfiguration

public final 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 final String semanticVersion()

The semantic version of the application:

https://semver.org/

Returns:

The semantic version of the application:

https://semver.org/

stackName

public final 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.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final 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.

You can use hasTags() to see if a value was sent in this field.

Returns:

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

templateId

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCloudFormationChangeSetRequest.Builder,CreateCloudFormationChangeSetRequest>

Specified by:

toBuilder in class ServerlessApplicationRepositoryRequest

builder

public static CreateCloudFormationChangeSetRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo