Class CfnStackSetProps.Jsii$Proxy
- All Implemented Interfaces:
CfnStackSetProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnStackSetProps
CfnStackSetProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.CfnStackSetProps
CfnStackSetProps.Builder, CfnStackSetProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnStackSetProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnStackSetProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal StringThe Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.final ObjectDescribes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).final StringSpecifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.The capabilities that are allowed in the StackSet.final StringA description of the StackSet.final StringThe name of the IAM execution role to use to create the StackSet.final ObjectDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.final ObjectThe user-specified preferences for how CloudFormation performs a StackSet operation.final ObjectThe input parameters for the StackSet template.final StringDescribes how the IAM roles required for StackSet operations are created.final ObjectA group of stack instances with parameters in some specific accounts and Regions.final StringThe name to associate with the StackSet.getTags()Key-value pairs to associate with this stack.final StringThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.final StringThe URL of a file that contains the template body.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnStackSetProps.Builder.
-
-
Method Details
-
getPermissionModel
Description copied from interface:CfnStackSetPropsDescribes how the IAM roles required for StackSet operations are created.- With
SELF_MANAGEDpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions in the AWS CloudFormation User Guide . - With
SERVICE_MANAGEDpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see Activate trusted access for StackSets with AWS Organizations in the AWS CloudFormation User Guide .
- Specified by:
getPermissionModelin interfaceCfnStackSetProps- See Also:
- With
-
getStackSetName
Description copied from interface:CfnStackSetPropsThe name to associate with the StackSet.The name must be unique in the Region where you create your StackSet.
- Specified by:
getStackSetNamein interfaceCfnStackSetProps- See Also:
-
getAdministrationRoleArn
Description copied from interface:CfnStackSetPropsThe Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account.
Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the AWS CloudFormation User Guide .
Valid only if the permissions model is
SELF_MANAGED.- Specified by:
getAdministrationRoleArnin interfaceCfnStackSetProps- See Also:
-
getAutoDeployment
Description copied from interface:CfnStackSetPropsDescribes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).For more information, see Enable or disable automatic deployments for StackSets in AWS Organizations in the AWS CloudFormation User Guide .
Required if the permissions model is
SERVICE_MANAGED. (Not used with self-managed permissions.)Returns union: either
IResolvableorCfnStackSet.AutoDeploymentProperty- Specified by:
getAutoDeploymentin interfaceCfnStackSetProps- See Also:
-
getCallAs
Description copied from interface:CfnStackSetPropsSpecifies 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,
SELFis specified. UseSELFfor StackSets with self-managed permissions.- To create a StackSet with service-managed permissions while signed in to the management account, specify
SELF. - To create a StackSet with service-managed permissions while signed in to a delegated administrator account, specify
DELEGATED_ADMIN.
Your AWS account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
StackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.
Valid only if the permissions model is
SERVICE_MANAGED.- Specified by:
getCallAsin interfaceCfnStackSetProps- See Also:
- To create a StackSet with service-managed permissions while signed in to the management account, specify
-
getCapabilities
Description copied from interface:CfnStackSetPropsThe capabilities that are allowed in the StackSet.Some StackSet templates might include resources that can affect permissions in your AWS account —for example, by creating new IAM users. For more information, see Acknowledging IAM resources in CloudFormation templates in the AWS CloudFormation User Guide .
- Specified by:
getCapabilitiesin interfaceCfnStackSetProps- See Also:
-
getDescription
Description copied from interface:CfnStackSetPropsA description of the StackSet.- Specified by:
getDescriptionin interfaceCfnStackSetProps- See Also:
-
getExecutionRoleName
Description copied from interface:CfnStackSetPropsThe name of the IAM execution role to use to create the StackSet.If you don't specify an execution role, CloudFormation uses the
AWSCloudFormationStackSetExecutionRolerole for the StackSet operation.Valid only if the permissions model is
SELF_MANAGED.Pattern :
[a-zA-Z_0-9+=,.@-]+- Specified by:
getExecutionRoleNamein interfaceCfnStackSetProps- See Also:
-
getManagedExecution
Description copied from interface:CfnStackSetPropsDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.
You can't modify your StackSet's execution configuration while there are running or queued operations for that StackSet.
When inactive (default), StackSets performs one operation at a time in request order.
- Specified by:
getManagedExecutionin interfaceCfnStackSetProps- See Also:
-
getOperationPreferences
Description copied from interface:CfnStackSetPropsThe user-specified preferences for how CloudFormation performs a StackSet operation.Returns union: either
IResolvableorCfnStackSet.OperationPreferencesProperty- Specified by:
getOperationPreferencesin interfaceCfnStackSetProps- See Also:
-
getParameters
Description copied from interface:CfnStackSetPropsThe input parameters for the StackSet template.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnStackSet.ParameterProperty>- Specified by:
getParametersin interfaceCfnStackSetProps- See Also:
-
getStackInstancesGroup
Description copied from interface:CfnStackSetPropsA group of stack instances with parameters in some specific accounts and Regions.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnStackSet.StackInstancesProperty>- Specified by:
getStackInstancesGroupin interfaceCfnStackSetProps- See Also:
-
getTags
Description copied from interface:CfnStackSetPropsKey-value pairs to associate with this stack.CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
- Specified by:
getTagsin interfaceCfnStackSetProps- See Also:
-
getTemplateBody
Description copied from interface:CfnStackSetPropsThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.You must include either
TemplateURLorTemplateBodyin a StackSet, but you can't use both. Dynamic references in theTemplateBodymay not work correctly in all cases. It's recommended to pass templates that contain dynamic references throughTemplateUrlinstead.- Specified by:
getTemplateBodyin interfaceCfnStackSetProps- See Also:
-
getTemplateUrl
Description copied from interface:CfnStackSetPropsThe URL of a file that contains the template body.The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with
https://.Conditional: You must specify only one of the following parameters:
TemplateBody,TemplateURL.- Specified by:
getTemplateUrlin interfaceCfnStackSetProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-