CreateCloudFormationChangeSetRequest (AWS Java SDK :: Services :: AWSServerlessApplicationRepository 2.20.103 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateCloudFormationChangeSetRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` For responses, this returns true if the service returned a value for the Capabilities property.
`int`	`hashCode()`
`boolean`	`hasNotificationArns()` For responses, this returns true if the service returned a value for the NotificationArns property.
`boolean`	`hasParameterOverrides()` For responses, this returns true if the service returned a value for the ParameterOverrides property.
`boolean`	`hasResourceTypes()` For responses, this returns true if the service returned a value for the ResourceTypes property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`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()
```
    For responses, this returns true if the service returned a value for the Capabilities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCapabilities() method.
    
    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()
```
    For responses, this returns true if the service returned a value for the NotificationArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotificationArns() method.
    
    Returns:
    
    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
  - hasParameterOverrides
```
public final boolean hasParameterOverrides()
```
    For responses, this returns true if the service returned a value for the ParameterOverrides property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameterOverrides() method.
    
    Returns:
    
    A list of parameter values for the parameters of the application.
  - hasResourceTypes
```
public final boolean hasResourceTypes()
```
    For responses, this returns true if the service returned a value for the ResourceTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceTypes() method.
    
    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()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    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

Class CreateCloudFormationChangeSetRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

applicationId

hasCapabilities

capabilities

changeSetName

clientToken

description

hasNotificationArns

notificationArns

hasParameterOverrides

parameterOverrides

hasResourceTypes

resourceTypes

rollbackConfiguration

semanticVersion

stackName

hasTags

tags

templateId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields