StackSetState class
Input properties used for looking up and filtering StackSet resources.
Constructors
-
StackSetState({Input<
String?> ? administrationRoleArn, Input<String?> ? arn, Input<StackSetAutoDeployment?> ? autoDeployment, Input<String?> ? callAs, Input<List< ? capabilities, Input<String> ?>String?> ? description, Input<String?> ? executionRoleName, Input<StackSetManagedExecution?> ? managedExecution, Input<String?> ? name, Input<StackSetOperationPreferences?> ? operationPreferences, Input<Map< ? parameters, Input<String, String> ?>String?> ? permissionModel, Input<String?> ? region, Input<String?> ? stackSetId, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? templateBody, Input<String?> ? templateUrl}) -
Creates a new StackSetState.
administrationRoleArnAmazon Resource Number (ARN) of the IAM Role in the administrator account. This must be defined when using theSELF_MANAGEDpermission model.arnARN of the StackSet.autoDeploymentConfiguration block containing the auto-deployment model for your StackSet. This can only be defined when using theSERVICE_MANAGEDpermission model.callAsSpecifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values:SELF(default),DELEGATED_ADMIN.capabilitiesA list of capabilities. Valid values:CAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_AUTO_EXPAND.descriptionDescription of the StackSet.executionRoleNameName of the IAM Role in all target accounts for StackSet operations. Defaults toAWSCloudFormationStackSetExecutionRolewhen using theSELF_MANAGEDpermission model. This should not be defined when using theSERVICE_MANAGEDpermission model.managedExecutionConfiguration block to allow StackSets to perform non-conflicting operations concurrently and queues conflicting operations.nameName of the StackSet. The name must be unique in the region where you create your StackSet. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.operationPreferencesPreferences for how AWS CloudFormation performs a stack set update.parametersKey-value map of input parameters for the StackSet template. All template parameters, including those with aDefault, must be configured or ignored withlifecycleconfiguration blockignoreChangesargument. AllNoEchotemplate parameters must be ignored with thelifecycleconfiguration blockignoreChangesargument.permissionModelDescribes how the IAM roles required for your StackSet are created. Valid values:SELF_MANAGED(default),SERVICE_MANAGED.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.stackSetIdUnique identifier of the StackSet.tagsKey-value map of tags to associate with this StackSet and the Stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the Stacks. A maximum number of 50 tags can be specified. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.templateBodyString containing the CloudFormation template body. Maximum size: 51,200 bytes. Conflicts withtemplateUrl.templateUrlString containing the location of a file containing the CloudFormation template body. The URL must point to a template that is located in an Amazon S3 bucket. Maximum location file size: 460,800 bytes. Conflicts withtemplateBody.const -
StackSetState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
administrationRoleArn
→ Input<
String?> ? -
Amazon Resource Number (ARN) of the IAM Role in the administrator account. This must be defined when using the
SELF_MANAGEDpermission model.final -
arn
→ Input<
String?> ? -
ARN of the StackSet.
final
-
autoDeployment
→ Input<
StackSetAutoDeployment?> ? -
Configuration block containing the auto-deployment model for your StackSet. This can only be defined when using the
SERVICE_MANAGEDpermission model.final -
callAs
→ Input<
String?> ? -
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values:
SELF(default),DELEGATED_ADMIN.final -
capabilities
→ Input<
List< ?String> ?> -
A list of capabilities. Valid values:
CAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_AUTO_EXPAND.final -
description
→ Input<
String?> ? -
Description of the StackSet.
final
-
executionRoleName
→ Input<
String?> ? -
Name of the IAM Role in all target accounts for StackSet operations. Defaults to
AWSCloudFormationStackSetExecutionRolewhen using theSELF_MANAGEDpermission model. This should not be defined when using theSERVICE_MANAGEDpermission model.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
managedExecution
→ Input<
StackSetManagedExecution?> ? -
Configuration block to allow StackSets to perform non-conflicting operations concurrently and queues conflicting operations.
final
-
name
→ Input<
String?> ? -
Name of the StackSet. The name must be unique in the region where you create your StackSet. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
final
-
operationPreferences
→ Input<
StackSetOperationPreferences?> ? -
Preferences for how AWS CloudFormation performs a stack set update.
final
-
parameters
→ Input<
Map< ?String, String> ?> -
Key-value map of input parameters for the StackSet template. All template parameters, including those with a
Default, must be configured or ignored withlifecycleconfiguration blockignoreChangesargument. AllNoEchotemplate parameters must be ignored with thelifecycleconfiguration blockignoreChangesargument.final -
permissionModel
→ Input<
String?> ? -
Describes how the IAM roles required for your StackSet are created. Valid values:
SELF_MANAGED(default),SERVICE_MANAGED.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stackSetId
→ Input<
String?> ? -
Unique identifier of the StackSet.
final
-
Key-value map of tags to associate with this StackSet and the Stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the Stacks. A maximum number of 50 tags can be specified. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
templateBody
→ Input<
String?> ? -
String containing the CloudFormation template body. Maximum size: 51,200 bytes. Conflicts with
templateUrl.final -
templateUrl
→ Input<
String?> ? -
String containing the location of a file containing the CloudFormation template body. The URL must point to a template that is located in an Amazon S3 bucket. Maximum location file size: 460,800 bytes. Conflicts with
templateBody.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited