@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StackSet extends Object implements Serializable, Cloneable
A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires.
Constructor and Description |
---|
StackSet() |
Modifier and Type | Method and Description |
---|---|
StackSet |
clone() |
boolean |
equals(Object obj) |
String |
getAdministrationRoleARN()
The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
|
AutoDeployment |
getAutoDeployment()
[
Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations
accounts that are added to a target organization or organizational unit (OU). |
List<String> |
getCapabilities()
The capabilities that are allowed in the stack set.
|
String |
getDescription()
A description of the stack set that you specify when the stack set is created or updated.
|
String |
getExecutionRoleName()
The name of the IAM execution role used to create or update the stack set.
|
List<String> |
getOrganizationalUnitIds()
[
Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you
specified for DeploymentTargets. |
List<Parameter> |
getParameters()
A list of input parameters for a stack set.
|
String |
getPermissionModel()
Describes how the IAM roles required for stack set operations are created.
|
String |
getStackSetARN()
The Amazon Resource Number (ARN) of the stack set.
|
StackSetDriftDetectionDetails |
getStackSetDriftDetectionDetails()
Detailed information about the drift status of the stack set.
|
String |
getStackSetId()
The ID of the stack set.
|
String |
getStackSetName()
The name that's associated with the stack set.
|
String |
getStatus()
The status of the stack set.
|
List<Tag> |
getTags()
A list of tags that specify information about the stack set.
|
String |
getTemplateBody()
The structure that contains the body of the template that was used to create or update the stack set.
|
int |
hashCode() |
void |
setAdministrationRoleARN(String administrationRoleARN)
The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
|
void |
setAutoDeployment(AutoDeployment autoDeployment)
[
Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations
accounts that are added to a target organization or organizational unit (OU). |
void |
setCapabilities(Collection<String> capabilities)
The capabilities that are allowed in the stack set.
|
void |
setDescription(String description)
A description of the stack set that you specify when the stack set is created or updated.
|
void |
setExecutionRoleName(String executionRoleName)
The name of the IAM execution role used to create or update the stack set.
|
void |
setOrganizationalUnitIds(Collection<String> organizationalUnitIds)
[
Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you
specified for DeploymentTargets. |
void |
setParameters(Collection<Parameter> parameters)
A list of input parameters for a stack set.
|
void |
setPermissionModel(PermissionModels permissionModel)
Describes how the IAM roles required for stack set operations are created.
|
void |
setPermissionModel(String permissionModel)
Describes how the IAM roles required for stack set operations are created.
|
void |
setStackSetARN(String stackSetARN)
The Amazon Resource Number (ARN) of the stack set.
|
void |
setStackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails)
Detailed information about the drift status of the stack set.
|
void |
setStackSetId(String stackSetId)
The ID of the stack set.
|
void |
setStackSetName(String stackSetName)
The name that's associated with the stack set.
|
void |
setStatus(StackSetStatus status)
The status of the stack set.
|
void |
setStatus(String status)
The status of the stack set.
|
void |
setTags(Collection<Tag> tags)
A list of tags that specify information about the stack set.
|
void |
setTemplateBody(String templateBody)
The structure that contains the body of the template that was used to create or update the stack set.
|
String |
toString()
Returns a string representation of this object.
|
StackSet |
withAdministrationRoleARN(String administrationRoleARN)
The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
|
StackSet |
withAutoDeployment(AutoDeployment autoDeployment)
[
Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations
accounts that are added to a target organization or organizational unit (OU). |
StackSet |
withCapabilities(Capability... capabilities)
The capabilities that are allowed in the stack set.
|
StackSet |
withCapabilities(Collection<String> capabilities)
The capabilities that are allowed in the stack set.
|
StackSet |
withCapabilities(String... capabilities)
The capabilities that are allowed in the stack set.
|
StackSet |
withDescription(String description)
A description of the stack set that you specify when the stack set is created or updated.
|
StackSet |
withExecutionRoleName(String executionRoleName)
The name of the IAM execution role used to create or update the stack set.
|
StackSet |
withOrganizationalUnitIds(Collection<String> organizationalUnitIds)
[
Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you
specified for DeploymentTargets. |
StackSet |
withOrganizationalUnitIds(String... organizationalUnitIds)
[
Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you
specified for DeploymentTargets. |
StackSet |
withParameters(Collection<Parameter> parameters)
A list of input parameters for a stack set.
|
StackSet |
withParameters(Parameter... parameters)
A list of input parameters for a stack set.
|
StackSet |
withPermissionModel(PermissionModels permissionModel)
Describes how the IAM roles required for stack set operations are created.
|
StackSet |
withPermissionModel(String permissionModel)
Describes how the IAM roles required for stack set operations are created.
|
StackSet |
withStackSetARN(String stackSetARN)
The Amazon Resource Number (ARN) of the stack set.
|
StackSet |
withStackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails)
Detailed information about the drift status of the stack set.
|
StackSet |
withStackSetId(String stackSetId)
The ID of the stack set.
|
StackSet |
withStackSetName(String stackSetName)
The name that's associated with the stack set.
|
StackSet |
withStatus(StackSetStatus status)
The status of the stack set.
|
StackSet |
withStatus(String status)
The status of the stack set.
|
StackSet |
withTags(Collection<Tag> tags)
A list of tags that specify information about the stack set.
|
StackSet |
withTags(Tag... tags)
A list of tags that specify information about the stack set.
|
StackSet |
withTemplateBody(String templateBody)
The structure that contains the body of the template that was used to create or update the stack set.
|
public void setStackSetName(String stackSetName)
The name that's associated with the stack set.
stackSetName
- The name that's associated with the stack set.public String getStackSetName()
The name that's associated with the stack set.
public StackSet withStackSetName(String stackSetName)
The name that's associated with the stack set.
stackSetName
- The name that's associated with the stack set.public void setStackSetId(String stackSetId)
The ID of the stack set.
stackSetId
- The ID of the stack set.public String getStackSetId()
The ID of the stack set.
public StackSet withStackSetId(String stackSetId)
The ID of the stack set.
stackSetId
- The ID of the stack set.public void setDescription(String description)
A description of the stack set that you specify when the stack set is created or updated.
description
- A description of the stack set that you specify when the stack set is created or updated.public String getDescription()
A description of the stack set that you specify when the stack set is created or updated.
public StackSet withDescription(String description)
A description of the stack set that you specify when the stack set is created or updated.
description
- A description of the stack set that you specify when the stack set is created or updated.public void setStatus(String status)
The status of the stack set.
status
- The status of the stack set.StackSetStatus
public String getStatus()
The status of the stack set.
StackSetStatus
public StackSet withStatus(String status)
The status of the stack set.
status
- The status of the stack set.StackSetStatus
public void setStatus(StackSetStatus status)
The status of the stack set.
status
- The status of the stack set.StackSetStatus
public StackSet withStatus(StackSetStatus status)
The status of the stack set.
status
- The status of the stack set.StackSetStatus
public void setTemplateBody(String templateBody)
The structure that contains the body of the template that was used to create or update the stack set.
templateBody
- The structure that contains the body of the template that was used to create or update the stack set.public String getTemplateBody()
The structure that contains the body of the template that was used to create or update the stack set.
public StackSet withTemplateBody(String templateBody)
The structure that contains the body of the template that was used to create or update the stack set.
templateBody
- The structure that contains the body of the template that was used to create or update the stack set.public List<Parameter> getParameters()
A list of input parameters for a stack set.
public void setParameters(Collection<Parameter> parameters)
A list of input parameters for a stack set.
parameters
- A list of input parameters for a stack set.public StackSet withParameters(Parameter... parameters)
A list of input parameters for a stack set.
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
- A list of input parameters for a stack set.public StackSet withParameters(Collection<Parameter> parameters)
A list of input parameters for a stack set.
parameters
- A list of input parameters for a stack set.public List<String> getCapabilities()
The capabilities that are allowed in the stack set. 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Capability
public void setCapabilities(Collection<String> capabilities)
The capabilities that are allowed in the stack set. 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- The capabilities that are allowed in the stack set. 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.Capability
public StackSet withCapabilities(String... capabilities)
The capabilities that are allowed in the stack set. 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
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
- The capabilities that are allowed in the stack set. 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.Capability
public StackSet withCapabilities(Collection<String> capabilities)
The capabilities that are allowed in the stack set. 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- The capabilities that are allowed in the stack set. 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.Capability
public StackSet withCapabilities(Capability... capabilities)
The capabilities that are allowed in the stack set. 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- The capabilities that are allowed in the stack set. 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.Capability
public List<Tag> getTags()
A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
public void setTags(Collection<Tag> tags)
A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
tags
- A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.public StackSet withTags(Tag... tags)
A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
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
- A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.public StackSet withTags(Collection<Tag> tags)
A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
tags
- A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.public void setStackSetARN(String stackSetARN)
The Amazon Resource Number (ARN) of the stack set.
stackSetARN
- The Amazon Resource Number (ARN) of the stack set.public String getStackSetARN()
The Amazon Resource Number (ARN) of the stack set.
public StackSet withStackSetARN(String stackSetARN)
The Amazon Resource Number (ARN) of the stack set.
stackSetARN
- The Amazon Resource Number (ARN) of the stack set.public void setAdministrationRoleARN(String administrationRoleARN)
The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
Use 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 AWS CloudFormation User Guide.
administrationRoleARN
- The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
Use 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 AWS CloudFormation User Guide.
public String getAdministrationRoleARN()
The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
Use 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 AWS CloudFormation User Guide.
Use 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 AWS CloudFormation User Guide.
public StackSet withAdministrationRoleARN(String administrationRoleARN)
The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
Use 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 AWS CloudFormation User Guide.
administrationRoleARN
- The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
Use 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 AWS CloudFormation User Guide.
public void setExecutionRoleName(String executionRoleName)
The name of the IAM execution role used to create or update the stack set.
Use 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 used to create or update the stack set.
Use 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 used to create or update the stack set.
Use customized execution roles to control which stack resources users and groups can include in their stack sets.
Use customized execution roles to control which stack resources users and groups can include in their stack sets.
public StackSet withExecutionRoleName(String executionRoleName)
The name of the IAM execution role used to create or update the stack set.
Use 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 used to create or update the stack set.
Use customized execution roles to control which stack resources users and groups can include in their stack sets.
public void setStackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails)
Detailed information about the drift status of the stack set.
For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress is not included.
stackSetDriftDetectionDetails
- Detailed information about the drift status of the stack set.
For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress is not included.
public StackSetDriftDetectionDetails getStackSetDriftDetectionDetails()
Detailed information about the drift status of the stack set.
For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress is not included.
For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress is not included.
public StackSet withStackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails)
Detailed information about the drift status of the stack set.
For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress is not included.
stackSetDriftDetectionDetails
- Detailed information about the drift status of the stack set.
For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress is not included.
public void setAutoDeployment(AutoDeployment autoDeployment)
[Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations
accounts that are added to a target organization or organizational unit (OU).
autoDeployment
- [Service-managed
permissions] Describes whether StackSets automatically deploys to AWS
Organizations accounts that are added to a target organization or organizational unit (OU).public AutoDeployment getAutoDeployment()
[Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations
accounts that are added to a target organization or organizational unit (OU).
Service-managed
permissions] Describes whether StackSets automatically deploys to AWS
Organizations accounts that are added to a target organization or organizational unit (OU).public StackSet withAutoDeployment(AutoDeployment autoDeployment)
[Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations
accounts that are added to a target organization or organizational unit (OU).
autoDeployment
- [Service-managed
permissions] Describes whether StackSets automatically deploys to AWS
Organizations accounts that are added to a target organization or organizational unit (OU).public void setPermissionModel(String permissionModel)
Describes how the IAM roles required for stack set operations are created.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
permissionModel
- Describes how the IAM roles required for stack set operations are created.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
PermissionModels
public String getPermissionModel()
Describes how the IAM roles required for stack set operations are created.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
PermissionModels
public StackSet withPermissionModel(String permissionModel)
Describes how the IAM roles required for stack set operations are created.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
permissionModel
- Describes how the IAM roles required for stack set operations are created.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
PermissionModels
public void setPermissionModel(PermissionModels permissionModel)
Describes how the IAM roles required for stack set operations are created.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
permissionModel
- Describes how the IAM roles required for stack set operations are created.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
PermissionModels
public StackSet withPermissionModel(PermissionModels permissionModel)
Describes how the IAM roles required for stack set operations are created.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
permissionModel
- Describes how the IAM roles required for stack set operations are created.
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
PermissionModels
public List<String> getOrganizationalUnitIds()
[Service-managed
permissions] The organization root ID or organizational unit (OU) IDs that you
specified for DeploymentTargets.
Service-managed
permissions] The organization root ID or organizational unit (OU) IDs that
you specified for DeploymentTargets.public void setOrganizationalUnitIds(Collection<String> organizationalUnitIds)
[Service-managed
permissions] The organization root ID or organizational unit (OU) IDs that you
specified for DeploymentTargets.
organizationalUnitIds
- [Service-managed
permissions] The organization root ID or organizational unit (OU) IDs that
you specified for DeploymentTargets.public StackSet withOrganizationalUnitIds(String... organizationalUnitIds)
[Service-managed
permissions] The organization root ID or organizational unit (OU) IDs that you
specified for DeploymentTargets.
NOTE: This method appends the values to the existing list (if any). Use
setOrganizationalUnitIds(java.util.Collection)
or
withOrganizationalUnitIds(java.util.Collection)
if you want to override the existing values.
organizationalUnitIds
- [Service-managed
permissions] The organization root ID or organizational unit (OU) IDs that
you specified for DeploymentTargets.public StackSet withOrganizationalUnitIds(Collection<String> organizationalUnitIds)
[Service-managed
permissions] The organization root ID or organizational unit (OU) IDs that you
specified for DeploymentTargets.
organizationalUnitIds
- [Service-managed
permissions] The organization root ID or organizational unit (OU) IDs that
you specified for DeploymentTargets.public String toString()
toString
in class Object
Object.toString()