Class: AWSCDK::CodePipelineActions::CodeStarConnectionsSourceActionProps

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

Overview

Construction properties for CodeStarConnectionsSourceAction.

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, connection_arn:, output:, owner:, repo:, branch: nil, code_build_clone_output: nil, trigger_on_push: nil) ⇒ CodeStarConnectionsSourceActionProps

Returns a new instance of CodeStarConnectionsSourceActionProps.

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.

  • connection_arn (String) —

    The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.

  • output (AWSCDK::Codepipeline::Artifact) —

    The output artifact that this action produces.

  • owner (String) —

    The owning user or organization of the repository.

  • repo (String) —

    The name of the repository.

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

    The branch to build.

  • code_build_clone_output (Boolean, nil) (defaults to: nil) —

    Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building.

  • trigger_on_push (Boolean, nil) (defaults to: nil) —

    Controls automatically starting your pipeline when a new commit is made on the configured repository and branch.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 18

def initialize(action_name:, run_order: nil, variables_namespace: nil, role: nil, connection_arn:, output:, owner:, repo:, branch: nil, code_build_clone_output: nil, trigger_on_push: 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?
  @connection_arn = connection_arn
  Jsii::Type.check_type(@connection_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectionArn")
  @output = output
  Jsii::Type.check_type(@output, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0In0=")), "output")
  @owner = owner
  Jsii::Type.check_type(@owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "owner")
  @repo = repo
  Jsii::Type.check_type(@repo, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "repo")
  @branch = branch
  Jsii::Type.check_type(@branch, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "branch") unless @branch.nil?
  @code_build_clone_output = code_build_clone_output
  Jsii::Type.check_type(@code_build_clone_output, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "codeBuildCloneOutput") unless @code_build_clone_output.nil?
  @trigger_on_push = trigger_on_push
  Jsii::Type.check_type(@trigger_on_push, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "triggerOnPush") unless @trigger_on_push.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) 


48
49
50
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 48

def action_name
  @action_name
end

#branch ⇒ String? (readonly)

Note:

Default: 'master'

The branch to build.

Returns:

  • (String, nil) 


102
103
104
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 102

def branch
  @branch
end

#code_build_clone_output ⇒ Boolean? (readonly)

Note:

Default: false

Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building.

Note: if this option is true, then only CodeBuild actions can use the resulting output.

Returns:

  • (Boolean, nil)

See Also:



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

def code_build_clone_output
  @code_build_clone_output
end

#connection_arn ⇒ String (readonly)

The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.

Examples:

"arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh"

Returns:

  • (String)

See Also:



79
80
81
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 79

def connection_arn
  @connection_arn
end

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

The output artifact that this action produces.

Can be used as input for further pipeline actions.

Returns:



85
86
87
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 85

def output
  @output
end

#owner ⇒ String (readonly)

The owning user or organization of the repository.

Examples:

"aws"

Returns:

  • (String) 


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

def owner
  @owner
end

#repo ⇒ String (readonly)

The name of the repository.

Examples:

"aws-cdk"

Returns:

  • (String) 


97
98
99
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 97

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



72
73
74
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 72

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:



56
57
58
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 56

def run_order
  @run_order
end

#trigger_on_push ⇒ Boolean? (readonly)

Note:

Default: true

Controls automatically starting your pipeline when a new commit is made on the configured repository and branch.

If unspecified, the default value is true, and the field does not display by default.

Returns:

  • (Boolean, nil)

See Also:



120
121
122
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 120

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


61
62
63
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 61

def variables_namespace
  @variables_namespace
end

Class Method Details

.jsii_properties ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 122

def self.jsii_properties
  {
    :action_name => "actionName",
    :run_order => "runOrder",
    :variables_namespace => "variablesNamespace",
    :role => "role",
    :connection_arn => "connectionArn",
    :output => "output",
    :owner => "owner",
    :repo => "repo",
    :branch => "branch",
    :code_build_clone_output => "codeBuildCloneOutput",
    :trigger_on_push => "triggerOnPush",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'code_pipeline_actions/code_star_connections_source_action_props.rb', line 138

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "actionName" => @action_name,
    "runOrder" => @run_order,
    "variablesNamespace" => @variables_namespace,
    "role" => @role,
    "connectionArn" => @connection_arn,
    "output" => @output,
    "owner" => @owner,
    "repo" => @repo,
    "branch" => @branch,
    "codeBuildCloneOutput" => @code_build_clone_output,
    "triggerOnPush" => @trigger_on_push,
  })
  result.compact
end