@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateStackSetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description | 
|---|
| CreateStackSetRequest() | 
| Modifier and Type | Method and Description | 
|---|---|
| CreateStackSetRequest | clone() | 
| boolean | equals(Object obj) | 
| String | getAdministrationRoleARN()
 The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. | 
| AutoDeployment | getAutoDeployment()
 Describes whether StackSets automatically deploys to Organizations accounts that are added to the target
 organization or organizational unit (OU). | 
| String | getCallAs()
 [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
 management account or as a delegated administrator in a member account. | 
| List<String> | getCapabilities()
 In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in
 order for CloudFormation to create the stack set and related stack instances. | 
| String | getClientRequestToken()
 A unique identifier for this  CreateStackSetrequest. | 
| String | getDescription()
 A description of the stack set. | 
| String | getExecutionRoleName()
 The name of the IAM execution role to use to create the stack set. | 
| List<Parameter> | getParameters()
 The input parameters for the stack set template. | 
| String | getPermissionModel()
 Describes how the IAM roles required for stack set operations are created. | 
| String | getStackId()
 The stack ID you are importing into a new stack set. | 
| String | getStackSetName()
 The name to associate with the stack set. | 
| List<Tag> | getTags()
 The key-value pairs to associate with this stack set and the stacks created from it. | 
| String | getTemplateBody()
 The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
 bytes. | 
| String | getTemplateURL()
 The location of the file that contains the template body. | 
| int | hashCode() | 
| void | setAdministrationRoleARN(String administrationRoleARN)
 The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. | 
| void | setAutoDeployment(AutoDeployment autoDeployment)
 Describes whether StackSets automatically deploys to Organizations accounts that are added to the target
 organization or organizational unit (OU). | 
| void | setCallAs(String callAs)
 [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
 management account or as a delegated administrator in a member account. | 
| void | setCapabilities(Collection<String> capabilities)
 In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in
 order for CloudFormation to create the stack set and related stack instances. | 
| void | setClientRequestToken(String clientRequestToken)
 A unique identifier for this  CreateStackSetrequest. | 
| void | setDescription(String description)
 A description of the stack set. | 
| void | setExecutionRoleName(String executionRoleName)
 The name of the IAM execution role to use to create the stack set. | 
| void | setParameters(Collection<Parameter> parameters)
 The input parameters for the stack set template. | 
| void | setPermissionModel(String permissionModel)
 Describes how the IAM roles required for stack set operations are created. | 
| void | setStackId(String stackId)
 The stack ID you are importing into a new stack set. | 
| void | setStackSetName(String stackSetName)
 The name to associate with the stack set. | 
| void | setTags(Collection<Tag> tags)
 The key-value pairs to associate with this stack set and the stacks created from it. | 
| void | setTemplateBody(String templateBody)
 The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
 bytes. | 
| void | setTemplateURL(String templateURL)
 The location of the file that contains the template body. | 
| String | toString()Returns a string representation of this object. | 
| CreateStackSetRequest | withAdministrationRoleARN(String administrationRoleARN)
 The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. | 
| CreateStackSetRequest | withAutoDeployment(AutoDeployment autoDeployment)
 Describes whether StackSets automatically deploys to Organizations accounts that are added to the target
 organization or organizational unit (OU). | 
| CreateStackSetRequest | withCallAs(CallAs callAs)
 [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
 management account or as a delegated administrator in a member account. | 
| CreateStackSetRequest | withCallAs(String callAs)
 [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
 management account or as a delegated administrator in a member account. | 
| CreateStackSetRequest | withCapabilities(Capability... capabilities)
 In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in
 order for CloudFormation to create the stack set and related stack instances. | 
| CreateStackSetRequest | withCapabilities(Collection<String> capabilities)
 In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in
 order for CloudFormation to create the stack set and related stack instances. | 
| CreateStackSetRequest | withCapabilities(String... capabilities)
 In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in
 order for CloudFormation to create the stack set and related stack instances. | 
| CreateStackSetRequest | withClientRequestToken(String clientRequestToken)
 A unique identifier for this  CreateStackSetrequest. | 
| CreateStackSetRequest | withDescription(String description)
 A description of the stack set. | 
| CreateStackSetRequest | withExecutionRoleName(String executionRoleName)
 The name of the IAM execution role to use to create the stack set. | 
| CreateStackSetRequest | withParameters(Collection<Parameter> parameters)
 The input parameters for the stack set template. | 
| CreateStackSetRequest | withParameters(Parameter... parameters)
 The input parameters for the stack set template. | 
| CreateStackSetRequest | withPermissionModel(PermissionModels permissionModel)
 Describes how the IAM roles required for stack set operations are created. | 
| CreateStackSetRequest | withPermissionModel(String permissionModel)
 Describes how the IAM roles required for stack set operations are created. | 
| CreateStackSetRequest | withStackId(String stackId)
 The stack ID you are importing into a new stack set. | 
| CreateStackSetRequest | withStackSetName(String stackSetName)
 The name to associate with the stack set. | 
| CreateStackSetRequest | withTags(Collection<Tag> tags)
 The key-value pairs to associate with this stack set and the stacks created from it. | 
| CreateStackSetRequest | withTags(Tag... tags)
 The key-value pairs to associate with this stack set and the stacks created from it. | 
| CreateStackSetRequest | withTemplateBody(String templateBody)
 The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
 bytes. | 
| CreateStackSetRequest | withTemplateURL(String templateURL)
 The location of the file that contains the template body. | 
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setStackSetName(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.
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.
public String getStackSetName()
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 CreateStackSetRequest withStackSetName(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.
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.
public void setDescription(String description)
A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
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 getDescription()
A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
public CreateStackSetRequest withDescription(String description)
A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
description - A description of the stack set. You can use the description to identify the stack set's purpose or other
        important information.public void setTemplateBody(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 CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
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 CloudFormation User Guide.
        Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
public String getTemplateBody()
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 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 CreateStackSetRequest withTemplateBody(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 CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
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 CloudFormation User Guide.
        Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
public void setTemplateURL(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 or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
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 or a Systems Manager document. For more information,
        see Template
        Anatomy in the CloudFormation User Guide.
        Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
public String getTemplateURL()
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 or a Systems Manager document. For more information, see Template Anatomy in the 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 CreateStackSetRequest withTemplateURL(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 or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
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 or a Systems Manager document. For more information,
        see Template
        Anatomy in the CloudFormation User Guide.
        Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
public void setStackId(String stackId)
The stack ID you are importing into a new stack set. Specify the Amazon Resource Number (ARN) of the stack.
stackId - The stack ID you are importing into a new stack set. Specify the Amazon Resource Number (ARN) of the
        stack.public String getStackId()
The stack ID you are importing into a new stack set. Specify the Amazon Resource Number (ARN) of the stack.
public CreateStackSetRequest withStackId(String stackId)
The stack ID you are importing into a new stack set. Specify the Amazon Resource Number (ARN) of the stack.
stackId - The stack ID you are importing into a new stack set. Specify the Amazon Resource Number (ARN) of the
        stack.public List<Parameter> getParameters()
The input parameters for the stack set template.
public void setParameters(Collection<Parameter> parameters)
The input parameters for the stack set template.
parameters - The input parameters for the stack set template.public CreateStackSetRequest withParameters(Parameter... parameters)
The input parameters for the stack set template.
 NOTE: This method appends the values to the existing list (if any). Use
 setParameters(java.util.Collection) or withParameters(java.util.Collection) if you want to
 override the existing values.
 
parameters - The input parameters for the stack set template.public CreateStackSetRequest withParameters(Collection<Parameter> parameters)
The input parameters for the stack set template.
parameters - The input parameters for the stack set template.public List<String> getCapabilities()
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
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 either of these capabilities, CloudFormation returns an
 InsufficientCapabilities error.
 
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
 CAPABILITY_AUTO_EXPAND
 
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
         CAPABILITY_IAM and CAPABILITY_NAMED_IAM
         
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
         The following IAM resources require you to specify either the CAPABILITY_IAM or
         CAPABILITY_NAMED_IAM capability.
         
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 either of these capabilities, CloudFormation returns an
         InsufficientCapabilities error.
         
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
         CAPABILITY_AUTO_EXPAND
         
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
Capabilitypublic void setCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
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 either of these capabilities, CloudFormation returns an
 InsufficientCapabilities error.
 
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
 CAPABILITY_AUTO_EXPAND
 
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
capabilities - In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities
        in order for CloudFormation to create the stack set and related stack instances.
        
        CAPABILITY_IAM and CAPABILITY_NAMED_IAM
        
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
        The following IAM resources require you to specify either the CAPABILITY_IAM or
        CAPABILITY_NAMED_IAM capability.
        
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 either of these capabilities, CloudFormation returns an
        InsufficientCapabilities error.
        
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
        CAPABILITY_AUTO_EXPAND
        
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
Capabilitypublic CreateStackSetRequest withCapabilities(String... capabilities)
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
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 either of these capabilities, CloudFormation returns an
 InsufficientCapabilities error.
 
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
 CAPABILITY_AUTO_EXPAND
 
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
 NOTE: This method appends the values to the existing list (if any). Use
 setCapabilities(java.util.Collection) or withCapabilities(java.util.Collection) if you want to
 override the existing values.
 
capabilities - In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities
        in order for CloudFormation to create the stack set and related stack instances.
        
        CAPABILITY_IAM and CAPABILITY_NAMED_IAM
        
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
        The following IAM resources require you to specify either the CAPABILITY_IAM or
        CAPABILITY_NAMED_IAM capability.
        
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 either of these capabilities, CloudFormation returns an
        InsufficientCapabilities error.
        
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
        CAPABILITY_AUTO_EXPAND
        
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
Capabilitypublic CreateStackSetRequest withCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
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 either of these capabilities, CloudFormation returns an
 InsufficientCapabilities error.
 
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
 CAPABILITY_AUTO_EXPAND
 
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
capabilities - In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities
        in order for CloudFormation to create the stack set and related stack instances.
        
        CAPABILITY_IAM and CAPABILITY_NAMED_IAM
        
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
        The following IAM resources require you to specify either the CAPABILITY_IAM or
        CAPABILITY_NAMED_IAM capability.
        
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 either of these capabilities, CloudFormation returns an
        InsufficientCapabilities error.
        
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
        CAPABILITY_AUTO_EXPAND
        
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
Capabilitypublic CreateStackSetRequest withCapabilities(Capability... capabilities)
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
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 either of these capabilities, CloudFormation returns an
 InsufficientCapabilities error.
 
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
 CAPABILITY_AUTO_EXPAND
 
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
capabilities - In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities
        in order for CloudFormation to create the stack set and related stack instances.
        
        CAPABILITY_IAM and CAPABILITY_NAMED_IAM
        
Some stack templates might include resources that can affect permissions in your account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
        The following IAM resources require you to specify either the CAPABILITY_IAM or
        CAPABILITY_NAMED_IAM capability.
        
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 either of these capabilities, CloudFormation returns an
        InsufficientCapabilities error.
        
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
        CAPABILITY_AUTO_EXPAND
        
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
Capabilitypublic List<Tag> getTags()
The key-value pairs to associate with this stack set and the stacks created from it. 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, 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.
 
         If you specify tags as part of a CreateStackSet action, 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 void setTags(Collection<Tag> tags)
The key-value pairs to associate with this stack set and the stacks created from it. 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, 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.
 
tags - The key-value pairs to associate with this stack set and the stacks created from it. 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, 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 CreateStackSetRequest withTags(Tag... tags)
The key-value pairs to associate with this stack set and the stacks created from it. 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, 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.
 
 NOTE: This method appends the values to the existing list (if any). Use
 setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
 existing values.
 
tags - The key-value pairs to associate with this stack set and the stacks created from it. 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, 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 CreateStackSetRequest withTags(Collection<Tag> tags)
The key-value pairs to associate with this stack set and the stacks created from it. 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, 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.
 
tags - The key-value pairs to associate with this stack set and the stacks created from it. 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, 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 void setAdministrationRoleARN(String administrationRoleARN)
The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
administrationRoleARN - The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. 
        Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
public String getAdministrationRoleARN()
The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
public CreateStackSetRequest withAdministrationRoleARN(String administrationRoleARN)
The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
administrationRoleARN - The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. 
        Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
public void setExecutionRoleName(String executionRoleName)
 The name of the IAM execution role to use to create the stack set. If you do not specify an execution role,
 CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
 
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
executionRoleName - The name of the IAM execution role to use to create the stack set. If you do not specify an execution
        role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set
        operation.
        Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
public String getExecutionRoleName()
 The name of the IAM execution role to use to create the stack set. If you do not specify an execution role,
 CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
 
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
AWSCloudFormationStackSetExecutionRole role for the stack set
         operation.
         Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
public CreateStackSetRequest withExecutionRoleName(String executionRoleName)
 The name of the IAM execution role to use to create the stack set. If you do not specify an execution role,
 CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
 
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
executionRoleName - The name of the IAM execution role to use to create the stack set. If you do not specify an execution
        role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set
        operation.
        Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
public void setPermissionModel(String permissionModel)
 Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED
 is specified.
 
 With self-managed permissions, you must create the administrator and execution roles required to
 deploy to target accounts. For more information, see Grant
 Self-Managed Stack Set Permissions.
 
 With service-managed permissions, StackSets automatically creates the IAM roles required to deploy
 to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
 
permissionModel - Describes how the IAM roles required for stack set operations are created. By default,
        SELF-MANAGED is specified.
        
        With self-managed permissions, you must create the administrator and execution roles required
        to deploy to target accounts. For more information, see Grant
        Self-Managed Stack Set Permissions.
        
        With service-managed permissions, StackSets automatically creates the IAM roles required to
        deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
        
PermissionModelspublic String getPermissionModel()
 Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED
 is specified.
 
 With self-managed permissions, you must create the administrator and execution roles required to
 deploy to target accounts. For more information, see Grant
 Self-Managed Stack Set Permissions.
 
 With service-managed permissions, StackSets automatically creates the IAM roles required to deploy
 to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
 
SELF-MANAGED is specified.
         
         With self-managed permissions, you must create the administrator and execution roles
         required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
         
         With service-managed permissions, StackSets automatically creates the IAM roles required to
         deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
         
PermissionModelspublic CreateStackSetRequest withPermissionModel(String permissionModel)
 Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED
 is specified.
 
 With self-managed permissions, you must create the administrator and execution roles required to
 deploy to target accounts. For more information, see Grant
 Self-Managed Stack Set Permissions.
 
 With service-managed permissions, StackSets automatically creates the IAM roles required to deploy
 to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
 
permissionModel - Describes how the IAM roles required for stack set operations are created. By default,
        SELF-MANAGED is specified.
        
        With self-managed permissions, you must create the administrator and execution roles required
        to deploy to target accounts. For more information, see Grant
        Self-Managed Stack Set Permissions.
        
        With service-managed permissions, StackSets automatically creates the IAM roles required to
        deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
        
PermissionModelspublic CreateStackSetRequest withPermissionModel(PermissionModels permissionModel)
 Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED
 is specified.
 
 With self-managed permissions, you must create the administrator and execution roles required to
 deploy to target accounts. For more information, see Grant
 Self-Managed Stack Set Permissions.
 
 With service-managed permissions, StackSets automatically creates the IAM roles required to deploy
 to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
 
permissionModel - Describes how the IAM roles required for stack set operations are created. By default,
        SELF-MANAGED is specified.
        
        With self-managed permissions, you must create the administrator and execution roles required
        to deploy to target accounts. For more information, see Grant
        Self-Managed Stack Set Permissions.
        
        With service-managed permissions, StackSets automatically creates the IAM roles required to
        deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
        
PermissionModelspublic void setAutoDeployment(AutoDeployment autoDeployment)
 Describes whether StackSets automatically deploys to Organizations accounts that are added to the target
 organization or organizational unit (OU). Specify only if PermissionModel is
 SERVICE_MANAGED.
 
autoDeployment - Describes whether StackSets automatically deploys to Organizations accounts that are added to the target
        organization or organizational unit (OU). Specify only if PermissionModel is
        SERVICE_MANAGED.public AutoDeployment getAutoDeployment()
 Describes whether StackSets automatically deploys to Organizations accounts that are added to the target
 organization or organizational unit (OU). Specify only if PermissionModel is
 SERVICE_MANAGED.
 
PermissionModel is
         SERVICE_MANAGED.public CreateStackSetRequest withAutoDeployment(AutoDeployment autoDeployment)
 Describes whether StackSets automatically deploys to Organizations accounts that are added to the target
 organization or organizational unit (OU). Specify only if PermissionModel is
 SERVICE_MANAGED.
 
autoDeployment - Describes whether StackSets automatically deploys to Organizations accounts that are added to the target
        organization or organizational unit (OU). Specify only if PermissionModel is
        SERVICE_MANAGED.public void setCallAs(String callAs)
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
 By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
 
 To create a stack set with service-managed permissions while signed in to the management account, specify
 SELF.
 
 To create a stack set with service-managed permissions while signed in to a delegated administrator account,
 specify DELEGATED_ADMIN.
 
Your account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the
        organization's management account or as a delegated administrator in a member account.
        
        By default, SELF is specified. Use SELF for stack sets with self-managed
        permissions.
        
        To create a stack set with service-managed permissions while signed in to the management account, specify
        SELF.
        
        To create a stack set with service-managed permissions while signed in to a delegated administrator
        account, specify DELEGATED_ADMIN.
        
Your account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
CallAspublic String getCallAs()
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
 By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
 
 To create a stack set with service-managed permissions while signed in to the management account, specify
 SELF.
 
 To create a stack set with service-managed permissions while signed in to a delegated administrator account,
 specify DELEGATED_ADMIN.
 
Your account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
         By default, SELF is specified. Use SELF for stack sets with self-managed
         permissions.
         
         To create a stack set with service-managed permissions while signed in to the management account, specify
         SELF.
         
         To create a stack set with service-managed permissions while signed in to a delegated administrator
         account, specify DELEGATED_ADMIN.
         
Your account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
CallAspublic CreateStackSetRequest withCallAs(String callAs)
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
 By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
 
 To create a stack set with service-managed permissions while signed in to the management account, specify
 SELF.
 
 To create a stack set with service-managed permissions while signed in to a delegated administrator account,
 specify DELEGATED_ADMIN.
 
Your account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the
        organization's management account or as a delegated administrator in a member account.
        
        By default, SELF is specified. Use SELF for stack sets with self-managed
        permissions.
        
        To create a stack set with service-managed permissions while signed in to the management account, specify
        SELF.
        
        To create a stack set with service-managed permissions while signed in to a delegated administrator
        account, specify DELEGATED_ADMIN.
        
Your account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
CallAspublic CreateStackSetRequest withCallAs(CallAs callAs)
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
 By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
 
 To create a stack set with service-managed permissions while signed in to the management account, specify
 SELF.
 
 To create a stack set with service-managed permissions while signed in to a delegated administrator account,
 specify DELEGATED_ADMIN.
 
Your account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the
        organization's management account or as a delegated administrator in a member account.
        
        By default, SELF is specified. Use SELF for stack sets with self-managed
        permissions.
        
        To create a stack set with service-managed permissions while signed in to the management account, specify
        SELF.
        
        To create a stack set with service-managed permissions while signed in to a delegated administrator
        account, specify DELEGATED_ADMIN.
        
Your account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
CallAspublic void setClientRequestToken(String clientRequestToken)
 A unique identifier for this CreateStackSet request. Specify this token if you plan to retry
 requests so that CloudFormation knows that you're not attempting to create another stack set with the same name.
 You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.
 
If you don't specify an operation ID, the SDK generates one automatically.
clientRequestToken - A unique identifier for this CreateStackSet request. Specify this token if you plan to retry
        requests so that CloudFormation knows that you're not attempting to create another stack set with the same
        name. You might retry CreateStackSet requests to ensure that CloudFormation successfully
        received them.
        If you don't specify an operation ID, the SDK generates one automatically.
public String getClientRequestToken()
 A unique identifier for this CreateStackSet request. Specify this token if you plan to retry
 requests so that CloudFormation knows that you're not attempting to create another stack set with the same name.
 You might retry CreateStackSet requests to ensure that 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 CloudFormation knows that you're not attempting to create another stack set with the
         same name. You might retry CreateStackSet requests to ensure that CloudFormation
         successfully received them.
         If you don't specify an operation ID, the SDK generates one automatically.
public CreateStackSetRequest withClientRequestToken(String clientRequestToken)
 A unique identifier for this CreateStackSet request. Specify this token if you plan to retry
 requests so that CloudFormation knows that you're not attempting to create another stack set with the same name.
 You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.
 
If you don't specify an operation ID, the SDK generates one automatically.
clientRequestToken - A unique identifier for this CreateStackSet request. Specify this token if you plan to retry
        requests so that CloudFormation knows that you're not attempting to create another stack set with the same
        name. You might retry CreateStackSet requests to ensure that CloudFormation successfully
        received them.
        If you don't specify an operation ID, the SDK generates one automatically.
public String toString()
toString in class ObjectObject.toString()public CreateStackSetRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2021. All rights reserved.