Class: AWSCDK::CodePipelineActions::ECRSourceActionProps

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

Overview

Construction properties of EcrSourceAction.

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, output:, repository:, image_tag: nil) ⇒ ECRSourceActionProps

Returns a new instance of ECRSourceActionProps.

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.

  • output (AWSCDK::Codepipeline::Artifact)
  • repository (AWSCDK::Interfaces::AWSECR::IRepositoryRef) —

    The repository that will be watched for changes.

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

    The image tag that will be checked for changes.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'code_pipeline_actions/ecr_source_action_props.rb', line 14

def initialize(action_name:, run_order: nil, variables_namespace: nil, role: nil, output:, repository:, image_tag: 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?
  @output = output
  Jsii::Type.check_type(@output, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0In0=")), "output")
  @repository = repository
  Jsii::Type.check_type(@repository, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lY3IuSVJlcG9zaXRvcnlSZWYifQ==")), "repository")
  @image_tag = image_tag
  Jsii::Type.check_type(@image_tag, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageTag") unless @image_tag.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) 


36
37
38
 
# File 'code_pipeline_actions/ecr_source_action_props.rb', line 36

def action_name
  @action_name
end

#image_tag ⇒ String? (readonly)

Note:

Default: 'latest'

The image tag that will be checked for changes.

It is not possible to trigger on changes to more than one tag.

Returns:

  • (String, nil) 


73
74
75
 
# File 'code_pipeline_actions/ecr_source_action_props.rb', line 73

def image_tag
  @image_tag
end

#output ⇒ AWSCDK::Codepipeline::Artifact (readonly)

Returns:



62
63
64
 
# File 'code_pipeline_actions/ecr_source_action_props.rb', line 62

def output
  @output
end

#repository ⇒ AWSCDK::Interfaces::AWSECR::IRepositoryRef (readonly)

The repository that will be watched for changes.

Returns:



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

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



60
61
62
 
# File 'code_pipeline_actions/ecr_source_action_props.rb', line 60

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:



44
45
46
 
# File 'code_pipeline_actions/ecr_source_action_props.rb', line 44

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) 


49
50
51
 
# File 'code_pipeline_actions/ecr_source_action_props.rb', line 49

def variables_namespace
  @variables_namespace
end

Class Method Details

.jsii_properties ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
 
# File 'code_pipeline_actions/ecr_source_action_props.rb', line 75

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

Instance Method Details

#to_jsii ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'code_pipeline_actions/ecr_source_action_props.rb', line 87

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