@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 |
|---|---|
String |
administrationRoleARN()
The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
|
AutoDeployment |
autoDeployment()
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target
organization or organizational unit (OU).
|
static CreateStackSetRequest.Builder |
builder() |
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.
|
String |
callAsAsString()
[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<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.
|
List<String> |
capabilitiesAsStrings()
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 |
clientRequestToken()
A unique identifier for this
CreateStackSet request. |
String |
description()
A description of the stack set.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
executionRoleName()
The name of the IAM execution role to use to create the stack set.
|
<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 |
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
List<Parameter> |
parameters()
The input parameters for the stack set template.
|
PermissionModels |
permissionModel()
Describes how the IAM roles required for stack set operations are created.
|
String |
permissionModelAsString()
Describes how the IAM roles required for stack set operations are created.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateStackSetRequest.Builder> |
serializableBuilderClass() |
String |
stackId()
The stack ID you are importing into a new stack set.
|
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() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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 final 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 final 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.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
public final 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.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
public final String stackId()
The stack ID you are importing into a new stack set. Specify the Amazon Resource Number (ARN) of the stack.
public final boolean hasParameters()
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.public final 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.
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 hasParameters() method.
public final List<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.
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.
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.
public final boolean hasCapabilities()
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.public final List<String> capabilitiesAsStrings()
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.
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.
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.
public final boolean hasTags()
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.public final List<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.
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.
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 final 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.
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 final 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.
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 final 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.
If the service returns an enum value that is not available in the current SDK version, permissionModel
will return PermissionModels.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from permissionModelAsString().
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 final String permissionModelAsString()
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.
If the service returns an enum value that is not available in the current SDK version, permissionModel
will return PermissionModels.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from permissionModelAsString().
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 final 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.
PermissionModel is
SERVICE_MANAGED.public final 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.
If the service returns an enum value that is not available in the current SDK version, callAs will
return CallAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
callAsAsString().
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 final String callAsAsString()
[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.
If the service returns an enum value that is not available in the current SDK version, callAs will
return CallAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
callAsAsString().
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 final 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.
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.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateStackSetRequest.Builder,CreateStackSetRequest>toBuilder in class CloudFormationRequestpublic static CreateStackSetRequest.Builder builder()
public static Class<? extends CreateStackSetRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.