@Stability(value=Stable) public static final class CloudFormationDeployStackSetActionProps.Builder extends Object implements software.amazon.jsii.Builder<CloudFormationDeployStackSetActionProps>
CloudFormationDeployStackSetActionProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder stackSetName(String stackSetName)
CloudFormationDeployStackSetActionProps.getStackSetName()stackSetName - The name to associate with the stack set. This parameter is required.
This name must be unique in the Region where it is created.
The name may only contain alphanumeric and hyphen characters. It must begin with an alphabetic character and be 128 characters or fewer.
this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder template(StackSetTemplate template)
CloudFormationDeployStackSetActionProps.getTemplate()template - The location of the template that defines the resources in the stack set. This parameter is required.
This must point to a template with a maximum size of 460,800 bytes.
Enter the path to the source artifact name and template file.
this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder cfnCapabilities(List<? extends CfnCapabilities> cfnCapabilities)
CloudFormationDeployStackSetActionProps.getCfnCapabilities()cfnCapabilities - Indicates that the template can create and update resources, depending on the types of resources in the template.
You must use this property if you have IAM resources in your stack template or you create a stack directly from a template containing macros.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder deploymentModel(StackSetDeploymentModel deploymentModel)
CloudFormationDeployStackSetActionProps.getDeploymentModel()deploymentModel - Determines how IAM roles are created and managed.
The choices are:
If you want to deploy to all accounts that are a member of AWS Organizations Organizational Units (OUs), you must select Service Managed permissions.
Note: This parameter can only be changed when no stack instances exist in the stack set.
this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder description(String description)
CloudFormationDeployStackSetActionProps.getDescription()description - A description of the stack set.
You can use this to describe the stack set’s purpose or other relevant information.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder parameters(StackSetParameters parameters)
CloudFormationDeployStackSetActionProps.getParameters()parameters - The template parameters for your stack set.
These parameters are shared between all instances of the stack set.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder stackInstances(StackInstances stackInstances)
CloudFormationDeployStackSetActionProps.getStackInstances()stackInstances - Specify where to create or update Stack Instances.
You can specify either AWS Accounts Ids or AWS Organizations Organizational Units.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder role(IRole role)
CommonAwsActionProps.getRole()role - The Role in which context's this Action will be executing in.
The Pipeline's Role will assume this Role
(the required permissions for that will be granted automatically)
right before executing this Action.
This Action will be passed into your {@link IAction.bind}
method in the {@link ActionBindOptions.role} property.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder actionName(String actionName)
CommonActionProps.getActionName()actionName - The physical, human-readable name of the Action. This parameter is required.
Note that Action names must be unique within a single Stage.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder runOrder(Number runOrder)
CommonActionProps.getRunOrder()runOrder - The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder variablesNamespace(String variablesNamespace)
CommonActionProps.getVariablesNamespace()variablesNamespace - The name of the namespace to use for variables emitted by this action.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder failureTolerancePercentage(Number failureTolerancePercentage)
CommonCloudFormationStackSetOptions.getFailureTolerancePercentage()failureTolerancePercentage - The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
If
the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in subsequent Regions. When calculating the number
of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder maxAccountConcurrencyPercentage(Number maxAccountConcurrencyPercentage)
CommonCloudFormationStackSetOptions.getMaxAccountConcurrencyPercentage()maxAccountConcurrencyPercentage - The maximum percentage of accounts in which to perform this operation at one time.
When calculating the number of accounts based on the specified
percentage, AWS CloudFormation rounds down to the next whole number. If rounding down would result in zero, AWS CloudFormation sets the number as
one instead. Although you use this setting to specify the maximum, for large deployments the actual number of accounts acted upon concurrently
may be lower due to service throttling.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps.Builder stackSetRegion(String stackSetRegion)
CommonCloudFormationStackSetOptions.getStackSetRegion()stackSetRegion - The AWS Region the StackSet is in.
Note that a cross-region Pipeline requires replication buckets to function correctly.
You can provide their names with the PipelineProps.crossRegionReplicationBuckets property.
If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets,
that you will need to cdk deploy before deploying the main, Pipeline-containing Stack.this@Stability(value=Stable) public CloudFormationDeployStackSetActionProps build()
build in interface software.amazon.jsii.Builder<CloudFormationDeployStackSetActionProps>CloudFormationDeployStackSetActionPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.