Class: AWSCDK::CodePipelineActions::CloudFormationDeployStackSetActionProps

Inherits:
AWSCDK::Codepipeline::CommonAWSActionProps
  • Object
show all
Defined in:
code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb

Overview

Properties for the CloudFormationDeployStackSetAction.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_name:, run_order: nil, variables_namespace: nil, role: nil, failure_tolerance_percentage: nil, max_account_concurrency_percentage: nil, stack_set_region: nil, stack_set_name:, template:, cfn_capabilities: nil, deployment_model: nil, description: nil, parameters: nil, stack_instances: nil) ⇒ CloudFormationDeployStackSetActionProps

Returns a new instance of CloudFormationDeployStackSetActionProps.

Parameters:

  • action_name (String) —

    The physical, human-readable name of the Action.

  • run_order (Numeric, nil) (defaults to: nil) —

    The runOrder property for this Action.

  • variables_namespace (String, nil) (defaults to: nil) —

    The name of the namespace to use for variables emitted by this action.

  • role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    The Role in which context's this Action will be executing in.

  • failure_tolerance_percentage (Numeric, nil) (defaults to: nil) —

    The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.

  • max_account_concurrency_percentage (Numeric, nil) (defaults to: nil) —

    The maximum percentage of accounts in which to perform this operation at one time.

  • stack_set_region (String, nil) (defaults to: nil) —

    The AWS Region the StackSet is in.

  • stack_set_name (String) —

    The name to associate with the stack set.

  • template (AWSCDK::CodePipelineActions::StackSetTemplate) —

    The location of the template that defines the resources in the stack set.

  • cfn_capabilities (Array<AWSCDK::CfnCapabilities>, nil) (defaults to: nil) —

    Indicates that the template can create and update resources, depending on the types of resources in the template.

  • deployment_model (AWSCDK::CodePipelineActions::StackSetDeploymentModel, nil) (defaults to: nil) —

    Determines how IAM roles are created and managed.

  • description (String, nil) (defaults to: nil) —

    A description of the stack set.

  • parameters (AWSCDK::CodePipelineActions::StackSetParameters, nil) (defaults to: nil) —

    The template parameters for your stack set.

  • stack_instances (AWSCDK::CodePipelineActions::StackInstances, nil) (defaults to: nil) —

    Specify where to create or update Stack Instances.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 22

def initialize(action_name:, run_order: nil, variables_namespace: nil, role: nil, failure_tolerance_percentage: nil, max_account_concurrency_percentage: nil, stack_set_region: nil, stack_set_name:, template:, cfn_capabilities: nil, deployment_model: nil, description: nil, parameters: nil, stack_instances: nil)
  @action_name = action_name
  Jsii::Type.check_type(@action_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actionName")
  @run_order = run_order
  Jsii::Type.check_type(@run_order, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "runOrder") unless @run_order.nil?
  @variables_namespace = variables_namespace
  Jsii::Type.check_type(@variables_namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "variablesNamespace") unless @variables_namespace.nil?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role") unless @role.nil?
  @failure_tolerance_percentage = failure_tolerance_percentage
  Jsii::Type.check_type(@failure_tolerance_percentage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "failureTolerancePercentage") unless @failure_tolerance_percentage.nil?
  @max_account_concurrency_percentage = 
  Jsii::Type.check_type(@max_account_concurrency_percentage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxAccountConcurrencyPercentage") unless @max_account_concurrency_percentage.nil?
  @stack_set_region = stack_set_region
  Jsii::Type.check_type(@stack_set_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stackSetRegion") unless @stack_set_region.nil?
  @stack_set_name = stack_set_name
  Jsii::Type.check_type(@stack_set_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stackSetName")
  @template = template
  Jsii::Type.check_type(@template, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lX2FjdGlvbnMuU3RhY2tTZXRUZW1wbGF0ZSJ9")), "template")
  @cfn_capabilities = cfn_capabilities
  Jsii::Type.check_type(@cfn_capabilities, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmbkNhcGFiaWxpdGllcyJ9LCJraW5kIjoiYXJyYXkifX0=")), "cfnCapabilities") unless @cfn_capabilities.nil?
  @deployment_model = deployment_model
  Jsii::Type.check_type(@deployment_model, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lX2FjdGlvbnMuU3RhY2tTZXREZXBsb3ltZW50TW9kZWwifQ==")), "deploymentModel") unless @deployment_model.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lX2FjdGlvbnMuU3RhY2tTZXRQYXJhbWV0ZXJzIn0=")), "parameters") unless @parameters.nil?
  @stack_instances = stack_instances
  Jsii::Type.check_type(@stack_instances, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lX2FjdGlvbnMuU3RhY2tJbnN0YW5jZXMifQ==")), "stackInstances") unless @stack_instances.nil?
end

Instance Attribute Details

#action_name ⇒ String (readonly)

The physical, human-readable name of the Action.

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

Returns:

  • (String) 


58
59
60
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 58

def action_name
  @action_name
end

#cfn_capabilities ⇒ Array<AWSCDK::CfnCapabilities>? (readonly)

Note:

Default: - the StackSet will have no IAM capabilities

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.

Returns:



134
135
136
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 134

def cfn_capabilities
  @cfn_capabilities
end

#deployment_model ⇒ AWSCDK::CodePipelineActions::StackSetDeploymentModel? (readonly)

Note:

Default: StackSetDeploymentModel.selfManaged()

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.

Returns:



154
155
156
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 154

def deployment_model
  @deployment_model
end

#description ⇒ String? (readonly)

Note:

Default: - no description

A description of the stack set.

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

Returns:

  • (String, nil) 


161
162
163
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 161

def description
  @description
end

#failure_tolerance_percentage ⇒ Numeric? (readonly)

Note:

Default: 0%

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.

Returns:

  • (Numeric, nil) 


91
92
93
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 91

def failure_tolerance_percentage
  @failure_tolerance_percentage
end

#max_account_concurrency_percentage ⇒ Numeric? (readonly)

Note:

Default: 1%

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.

Returns:

  • (Numeric, nil) 


101
102
103
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 101

def 
  @max_account_concurrency_percentage
end

#parameters ⇒ AWSCDK::CodePipelineActions::StackSetParameters? (readonly)

Note:

Default: - no parameters will be used

The template parameters for your stack set.

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

Returns:



168
169
170
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 168

def parameters
  @parameters
end

#role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: a new Role will be generated

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.

Returns:



82
83
84
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 82

def role
  @role
end

#run_order ⇒ Numeric? (readonly)

Note:

Default: 1

The runOrder property for this Action.

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

Returns:

  • (Numeric, nil)

See Also:



66
67
68
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 66

def run_order
  @run_order
end

#stack_instances ⇒ AWSCDK::CodePipelineActions::StackInstances? (readonly)

Note:

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

Specify where to create or update Stack Instances.

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

Returns:



175
176
177
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 175

def stack_instances
  @stack_instances
end

#stack_set_name ⇒ String (readonly)

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.

Returns:

  • (String) 


119
120
121
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 119

def stack_set_name
  @stack_set_name
end

#stack_set_region ⇒ String? (readonly)

Note:

Default: - same region as the Pipeline

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.

Returns:

  • (String, nil) 


111
112
113
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 111

def stack_set_region
  @stack_set_region
end

#template ⇒ AWSCDK::CodePipelineActions::StackSetTemplate (readonly)

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.

Returns:



127
128
129
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 127

def template
  @template
end

#variables_namespace ⇒ String? (readonly)

Note:

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

The name of the namespace to use for variables emitted by this action.

Returns:

  • (String, nil) 


71
72
73
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 71

def variables_namespace
  @variables_namespace
end

Class Method Details

.jsii_properties ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 177

def self.jsii_properties
  {
    :action_name => "actionName",
    :run_order => "runOrder",
    :variables_namespace => "variablesNamespace",
    :role => "role",
    :failure_tolerance_percentage => "failureTolerancePercentage",
    :max_account_concurrency_percentage => "maxAccountConcurrencyPercentage",
    :stack_set_region => "stackSetRegion",
    :stack_set_name => "stackSetName",
    :template => "template",
    :cfn_capabilities => "cfnCapabilities",
    :deployment_model => "deploymentModel",
    :description => "description",
    :parameters => "parameters",
    :stack_instances => "stackInstances",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_set_action_props.rb', line 196

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "actionName" => @action_name,
    "runOrder" => @run_order,
    "variablesNamespace" => @variables_namespace,
    "role" => @role,
    "failureTolerancePercentage" => @failure_tolerance_percentage,
    "maxAccountConcurrencyPercentage" => @max_account_concurrency_percentage,
    "stackSetRegion" => @stack_set_region,
    "stackSetName" => @stack_set_name,
    "template" => @template,
    "cfnCapabilities" => @cfn_capabilities,
    "deploymentModel" => @deployment_model,
    "description" => @description,
    "parameters" => @parameters,
    "stackInstances" => @stack_instances,
  })
  result.compact
end