Package software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationDeployStackSetActionProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.codepipeline.actions.CloudFormationDeployStackSetActionProps.Jsii$Proxy
All Implemented Interfaces:
CloudFormationDeployStackSetActionProps, CommonCloudFormationStackSetOptions, CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CloudFormationDeployStackSetActionProps
@Stability(Stable) @Internal public static final class CloudFormationDeployStackSetActionProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CloudFormationDeployStackSetActionProps
An implementation for CloudFormationDeployStackSetActionProps

  • Constructor Details

  • Method Details

    • getStackSetName

      public final String getStackSetName()
      Description copied from interface: CloudFormationDeployStackSetActionProps
      The name to associate with the stack set.

      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.

      Specified by:
      getStackSetName in interface CloudFormationDeployStackSetActionProps

    • getTemplate

      public final StackSetTemplate getTemplate()
      Description copied from interface: CloudFormationDeployStackSetActionProps
      The location of the template that defines the resources in the stack set.

      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.

      Specified by:
      getTemplate in interface CloudFormationDeployStackSetActionProps

    • getCfnCapabilities

      public final List<CfnCapabilities> getCfnCapabilities()
      Description copied from interface: CloudFormationDeployStackSetActionProps
      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.

      Default: - the StackSet will have no IAM capabilities

      Specified by:
      getCfnCapabilities in interface CloudFormationDeployStackSetActionProps

    • getDeploymentModel

      public final StackSetDeploymentModel getDeploymentModel()
      Description copied from interface: CloudFormationDeployStackSetActionProps
      Determines how IAM roles are created and managed.

      The choices are:

      • Self Managed: you create IAM roles with the required permissions in the administration account and all target accounts.
      • Service Managed: only available if the account and target accounts are part of an AWS Organization. The necessary roles will be created for you.

      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.

      Default: StackSetDeploymentModel.selfManaged()

      Specified by:
      getDeploymentModel in interface CloudFormationDeployStackSetActionProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CloudFormationDeployStackSetActionProps
      A description of the stack set.

      You can use this to describe the stack set’s purpose or other relevant information.

      Default: - no description

      Specified by:
      getDescription in interface CloudFormationDeployStackSetActionProps

    • getParameters

      public final StackSetParameters getParameters()
      Description copied from interface: CloudFormationDeployStackSetActionProps
      The template parameters for your stack set.

      These parameters are shared between all instances of the stack set.

      Default: - no parameters will be used

      Specified by:
      getParameters in interface CloudFormationDeployStackSetActionProps

    • getStackInstances

      public final StackInstances getStackInstances()
      Description copied from interface: CloudFormationDeployStackSetActionProps
      Specify where to create or update Stack Instances.

      You can specify either AWS Accounts Ids or AWS Organizations Organizational Units.

      Default: - don't create or update any Stack Instances

      Specified by:
      getStackInstances in interface CloudFormationDeployStackSetActionProps

    • getRole

      public final IRole getRole()
      Description copied from interface: CommonAwsActionProps
      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 IAction.bind method in the ActionBindOptions.role property.

      Default: a new Role will be generated

      Specified by:
      getRole in interface CommonAwsActionProps

    • getActionName

      public final String getActionName()
      Description copied from interface: CommonActionProps
      The physical, human-readable name of the Action.

      Note that Action names must be unique within a single Stage.

      Specified by:
      getActionName in interface CommonActionProps

    • getRunOrder

      public final Number getRunOrder()
      Description copied from interface: CommonActionProps
      The runOrder property for this Action.

      RunOrder determines the relative order in which multiple Actions in the same Stage execute.

      Default: 1

      Specified by:
      getRunOrder in interface CommonActionProps
      See Also:

    • getVariablesNamespace

      public final String getVariablesNamespace()
      Description copied from interface: CommonActionProps
      The name of the namespace to use for variables emitted by this action.

      Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

      Specified by:
      getVariablesNamespace in interface CommonActionProps

    • getFailureTolerancePercentage

      public final Number getFailureTolerancePercentage()
      Description copied from interface: CommonCloudFormationStackSetOptions
      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.

      Default: 0%

      Specified by:
      getFailureTolerancePercentage in interface CommonCloudFormationStackSetOptions

    • getMaxAccountConcurrencyPercentage

      public final Number getMaxAccountConcurrencyPercentage()
      Description copied from interface: CommonCloudFormationStackSetOptions
      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.

      Default: 1%

      Specified by:
      getMaxAccountConcurrencyPercentage in interface CommonCloudFormationStackSetOptions

    • getStackSetRegion

      public final String getStackSetRegion()
      Description copied from interface: CommonCloudFormationStackSetOptions
      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.

      Default: - same region as the Pipeline

      Specified by:
      getStackSetRegion in interface CommonCloudFormationStackSetOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object