Class: AWSCDK::Codepipeline::CommonAWSActionProps

Inherits:
CommonActionProps
  • Object
show all
Defined in:
codepipeline/common_aws_action_props.rb

Overview

Common properties shared by all Actions whose ActionProperties.owner field is 'AWS' (or unset, as 'AWS' is the default).

Direct Known Subclasses

AWSCDK::CodePipelineActions::CloudFormationCreateReplaceChangeSetActionProps, AWSCDK::CodePipelineActions::CloudFormationCreateUpdateStackActionProps, AWSCDK::CodePipelineActions::CloudFormationDeleteStackActionProps, AWSCDK::CodePipelineActions::CloudFormationDeployStackInstancesActionProps, AWSCDK::CodePipelineActions::CloudFormationDeployStackSetActionProps, AWSCDK::CodePipelineActions::CloudFormationExecuteChangeSetActionProps, AWSCDK::CodePipelineActions::CodeBuildActionProps, AWSCDK::CodePipelineActions::CodeCommitSourceActionProps, AWSCDK::CodePipelineActions::CodeDeployECSDeployActionProps, AWSCDK::CodePipelineActions::CodeDeployServerDeployActionProps, AWSCDK::CodePipelineActions::CodeStarConnectionsSourceActionProps, AWSCDK::CodePipelineActions::CommandsActionProps, AWSCDK::CodePipelineActions::EC2DeployActionProps, AWSCDK::CodePipelineActions::ECRBuildAndPublishActionProps, AWSCDK::CodePipelineActions::ECRSourceActionProps, AWSCDK::CodePipelineActions::ECSDeployActionProps, AWSCDK::CodePipelineActions::ElasticBeanstalkDeployActionProps, AWSCDK::CodePipelineActions::InspectorScanActionBaseProps, AWSCDK::CodePipelineActions::LambdaInvokeActionProps, AWSCDK::CodePipelineActions::ManualApprovalActionProps, AWSCDK::CodePipelineActions::PipelineInvokeActionProps, AWSCDK::CodePipelineActions::S3DeployActionProps, AWSCDK::CodePipelineActions::S3SourceActionProps, AWSCDK::CodePipelineActions::ServiceCatalogDeployActionBeta1Props, AWSCDK::CodePipelineActions::StepFunctionsInvokeActionProps

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) ⇒ CommonAWSActionProps

Returns a new instance of CommonAWSActionProps.

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.



11
12
13
14
15
16
17
18
19
20
 
# File 'codepipeline/common_aws_action_props.rb', line 11

def initialize(action_name:, run_order: nil, variables_namespace: nil, role: 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?
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) 


27
28
29
 
# File 'codepipeline/common_aws_action_props.rb', line 27

def action_name
  @action_name
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:



51
52
53
 
# File 'codepipeline/common_aws_action_props.rb', line 51

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:



35
36
37
 
# File 'codepipeline/common_aws_action_props.rb', line 35

def run_order
  @run_order
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) 


40
41
42
 
# File 'codepipeline/common_aws_action_props.rb', line 40

def variables_namespace
  @variables_namespace
end

Class Method Details

.jsii_properties ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'codepipeline/common_aws_action_props.rb', line 53

def self.jsii_properties
  {
    :action_name => "actionName",
    :run_order => "runOrder",
    :variables_namespace => "variablesNamespace",
    :role => "role",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
 
# File 'codepipeline/common_aws_action_props.rb', line 62

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "actionName" => @action_name,
    "runOrder" => @run_order,
    "variablesNamespace" => @variables_namespace,
    "role" => @role,
  })
  result.compact
end