@Generated(value="software.amazon.awssdk:codegen") public final class CreateStackSetRequest extends CloudFormationRequest implements ToCopyableBuilder<CreateStackSetRequest.Builder,CreateStackSetRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateStackSetRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateStackSetRequest.Builder |
builder() |
List<Capability> |
capabilities()
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
List<String> |
capabilitiesAsStrings()
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
String |
clientRequestToken()
A unique identifier for this
CreateStackSet request. |
String |
description()
A description of the stack set.
|
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<Parameter> |
parameters()
The input parameters for the stack set template.
|
static Class<? extends CreateStackSetRequest.Builder> |
serializableBuilderClass() |
String |
stackSetName()
The name to associate with the stack set.
|
List<Tag> |
tags()
The key-value pairs to associate with this stack set and the stacks created from it.
|
String |
templateBody()
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
bytes.
|
String |
templateURL()
The location of the file that contains the template body.
|
CreateStackSetRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String stackSetName()
The name to associate with the stack set. The name must be unique in the region where you create your stack set.
A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
public String description()
A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
public String templateBody()
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
public String templateURL()
The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
public List<Parameter> parameters()
The input parameters for the stack set template.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Capability> capabilities()
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set 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 stack sets, 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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.
public List<String> capabilitiesAsStrings()
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set 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 stack sets, 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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.
public List<Tag> tags()
The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
If you specify tags as part of a CreateStackSet
action, AWS CloudFormation checks to see if you have
the required IAM permission to tag resources. If you don't, the entire CreateStackSet
action fails
with an access denied
error, and the stack set is not created.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
If you specify tags as part of a CreateStackSet
action, AWS CloudFormation checks to see if
you have the required IAM permission to tag resources. If you don't, the entire
CreateStackSet
action fails with an access denied
error, and the stack set is
not created.
public String clientRequestToken()
A unique identifier for this CreateStackSet
request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same
name. You might retry CreateStackSet
requests to ensure that AWS CloudFormation successfully
received them.
If you don't specify an operation ID, the SDK generates one automatically.
CreateStackSet
request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the
same name. You might retry CreateStackSet
requests to ensure that AWS CloudFormation
successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
public CreateStackSetRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateStackSetRequest.Builder,CreateStackSetRequest>
toBuilder
in class CloudFormationRequest
public static CreateStackSetRequest.Builder builder()
public static Class<? extends CreateStackSetRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.