Class: AWSCDK::Pipelines::CodeCommitSourceOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pipelines/code_commit_source_options.rb

Overview

Configuration options for a CodeCommit source.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_name: nil, code_build_clone_output: nil, event_role: nil, trigger: nil) ⇒ CodeCommitSourceOptions

Returns a new instance of CodeCommitSourceOptions.

Parameters:

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

    The action name used for this source in the CodePipeline.

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

    If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).

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

    Role to be used by on commit event rule.

  • trigger (AWSCDK::CodePipelineActions::CodeCommitTrigger, nil) (defaults to: nil) —

    How should CodePipeline detect source changes for this Action.



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

def initialize(action_name: nil, code_build_clone_output: nil, event_role: nil, trigger: nil)
  @action_name = action_name
  Jsii::Type.check_type(@action_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actionName") unless @action_name.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?
  @event_role = event_role
  Jsii::Type.check_type(@event_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "eventRole") unless @event_role.nil?
  @trigger = trigger
  Jsii::Type.check_type(@trigger, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lX2FjdGlvbnMuQ29kZUNvbW1pdFRyaWdnZXIifQ==")), "trigger") unless @trigger.nil?
end

Instance Attribute Details

#action_name ⇒ String? (readonly)

Note:

Default: - The repository name

The action name used for this source in the CodePipeline.

Returns:

  • (String, nil) 


26
27
28
 
# File 'pipelines/code_commit_source_options.rb', line 26

def action_name
  @action_name
end

#code_build_clone_output ⇒ Boolean? (readonly)

Note:

Default: false

If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).

This provides access to repository history, and retains symlinks (symlinks would otherwise be removed by CodePipeline).

Note: if this option is true, only CodeBuild jobs can use the output artifact.

Returns:

  • (Boolean, nil)

See Also:



37
38
39
 
# File 'pipelines/code_commit_source_options.rb', line 37

def code_build_clone_output
  @code_build_clone_output
end

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

Note:

Default: a new role will be created.

Role to be used by on commit event rule.

Used only when trigger value is CodeCommitTrigger.EVENTS.

Returns:



44
45
46
 
# File 'pipelines/code_commit_source_options.rb', line 44

def event_role
  @event_role
end

#trigger ⇒ AWSCDK::CodePipelineActions::CodeCommitTrigger? (readonly)

Note:

Default: CodeCommitTrigger.EVENTS

How should CodePipeline detect source changes for this Action.

Returns:



49
50
51
 
# File 'pipelines/code_commit_source_options.rb', line 49

def trigger
  @trigger
end

Class Method Details

.jsii_properties ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'pipelines/code_commit_source_options.rb', line 51

def self.jsii_properties
  {
    :action_name => "actionName",
    :code_build_clone_output => "codeBuildCloneOutput",
    :event_role => "eventRole",
    :trigger => "trigger",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



60
61
62
63
64
65
66
67
68
69
 
# File 'pipelines/code_commit_source_options.rb', line 60

def to_jsii
  result = {}
  result.merge!({
    "actionName" => @action_name,
    "codeBuildCloneOutput" => @code_build_clone_output,
    "eventRole" => @event_role,
    "trigger" => @trigger,
  })
  result.compact
end