StackSetArgs class

The set of arguments for StackSet. The set of arguments for StackSet.

Constructors

StackSetArgs({Input<String?>? administrationRoleArn, Input<StackSetAutoDeployment?>? autoDeployment, Input<String?>? callAs, Input<List<String>?>? capabilities, Input<String?>? description, Input<String?>? executionRoleName, Input<StackSetManagedExecution?>? managedExecution, Input<String?>? name, Input<StackSetOperationPreferences?>? operationPreferences, Input<Map<String, String>?>? parameters, Input<String?>? permissionModel, Input<String?>? region, Input<Map<String, String>?>? tags, Input<String?>? templateBody, Input<String?>? templateUrl})
Creates a new StackSetArgs. administrationRoleArn Amazon Resource Number (ARN) of the IAM Role in the administrator account. This must be defined when using the SELF_MANAGED permission model. autoDeployment Configuration block containing the auto-deployment model for your StackSet. This can only be defined when using the SERVICE_MANAGED permission model. callAs 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. capabilities A list of capabilities. Valid values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND. description Description of the StackSet. executionRoleName Name of the IAM Role in all target accounts for StackSet operations. Defaults to AWSCloudFormationStackSetExecutionRole when using the SELF_MANAGED permission model. This should not be defined when using the SERVICE_MANAGED permission model. managedExecution Configuration block to allow StackSets to perform non-conflicting operations concurrently and queues conflicting operations. name 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. operationPreferences Preferences for how AWS CloudFormation performs a stack set update. parameters Key-value map of input parameters for the StackSet template. All template parameters, including those with a Default, must be configured or ignored with lifecycle configuration block ignoreChanges argument. All NoEcho template parameters must be ignored with the lifecycle configuration block ignoreChanges argument. permissionModel Describes how the IAM roles required for your StackSet are created. Valid values: SELF_MANAGED (default), SERVICE_MANAGED. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. tags 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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. templateBody String containing the CloudFormation template body. Maximum size: 51,200 bytes. Conflicts with templateUrl. templateUrl 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.
const
StackSetArgs.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_MANAGED permission model.
final
autoDeployment → Input<StackSetAutoDeployment?>?
Configuration block containing the auto-deployment model for your StackSet. This can only be defined when using the SERVICE_MANAGED permission 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 AWSCloudFormationStackSetExecutionRole when using the SELF_MANAGED permission model. This should not be defined when using the SERVICE_MANAGED permission 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 with lifecycle configuration block ignoreChanges argument. All NoEcho template parameters must be ignored with the lifecycle configuration block ignoreChanges argument.
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
tags → Input<Map<String, String>?>?
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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
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