Class: AWSCDK::Codepipeline::CustomActionRegistrationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
codepipeline/custom_action_registration_props.rb

Overview

Properties of registering a custom Action.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(artifact_bounds:, category:, provider:, action_properties: nil, entity_url: nil, execution_url: nil, version: nil) ⇒ CustomActionRegistrationProps

Returns a new instance of CustomActionRegistrationProps.

Parameters:

  • artifact_bounds (AWSCDK::Codepipeline::ActionArtifactBounds) —

    The artifact bounds of the Action.

  • category (AWSCDK::Codepipeline::ActionCategory) —

    The category of the Action.

  • provider (String) —

    The provider of the Action.

  • action_properties (Array<AWSCDK::Codepipeline::CustomActionProperty>, nil) (defaults to: nil) —

    The properties used for customizing the instance of your Action.

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

    The URL shown for the entire Action in the Pipeline UI.

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

    The URL shown for a particular execution of an Action in the Pipeline UI.

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

    The version of your Action.



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

def initialize(artifact_bounds:, category:, provider:, action_properties: nil, entity_url: nil, execution_url: nil, version: nil)
  @artifact_bounds = artifact_bounds.is_a?(Hash) ? ::AWSCDK::Codepipeline::ActionArtifactBounds.new(**artifact_bounds.transform_keys(&:to_sym)) : artifact_bounds
  Jsii::Type.check_type(@artifact_bounds, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFjdGlvbkFydGlmYWN0Qm91bmRzIn0=")), "artifactBounds")
  @category = category
  Jsii::Type.check_type(@category, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFjdGlvbkNhdGVnb3J5In0=")), "category")
  @provider = provider
  Jsii::Type.check_type(@provider, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "provider")
  @action_properties = action_properties.is_a?(Array) ? action_properties.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::Codepipeline::CustomActionProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : action_properties
  Jsii::Type.check_type(@action_properties, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ3VzdG9tQWN0aW9uUHJvcGVydHkifSwia2luZCI6ImFycmF5In19")), "actionProperties") unless @action_properties.nil?
  @entity_url = entity_url
  Jsii::Type.check_type(@entity_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "entityUrl") unless @entity_url.nil?
  @execution_url = execution_url
  Jsii::Type.check_type(@execution_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionUrl") unless @execution_url.nil?
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless @version.nil?
end

Instance Attribute Details

#action_properties ⇒ Array<AWSCDK::Codepipeline::CustomActionProperty>? (readonly)

Note:

Default: []

The properties used for customizing the instance of your Action.

Returns:



49
50
51
 
# File 'codepipeline/custom_action_registration_props.rb', line 49

def action_properties
  @action_properties
end

#artifact_bounds ⇒ AWSCDK::Codepipeline::ActionArtifactBounds (readonly)

The artifact bounds of the Action.

Returns:



34
35
36
 
# File 'codepipeline/custom_action_registration_props.rb', line 34

def artifact_bounds
  @artifact_bounds
end

#category ⇒ AWSCDK::Codepipeline::ActionCategory (readonly)

The category of the Action.

Returns:



38
39
40
 
# File 'codepipeline/custom_action_registration_props.rb', line 38

def category
  @category
end

#entity_url ⇒ String? (readonly)

Note:

Default: none

The URL shown for the entire Action in the Pipeline UI.

Returns:

  • (String, nil) 


54
55
56
 
# File 'codepipeline/custom_action_registration_props.rb', line 54

def entity_url
  @entity_url
end

#execution_url ⇒ String? (readonly)

Note:

Default: none

The URL shown for a particular execution of an Action in the Pipeline UI.

Returns:

  • (String, nil) 


59
60
61
 
# File 'codepipeline/custom_action_registration_props.rb', line 59

def execution_url
  @execution_url
end

#provider ⇒ String (readonly)

The provider of the Action.

For example, 'MyCustomActionProvider'

Returns:

  • (String) 


44
45
46
 
# File 'codepipeline/custom_action_registration_props.rb', line 44

def provider
  @provider
end

#version ⇒ String? (readonly)

Note:

Default: '1'

The version of your Action.

Returns:

  • (String, nil) 


64
65
66
 
# File 'codepipeline/custom_action_registration_props.rb', line 64

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
 
# File 'codepipeline/custom_action_registration_props.rb', line 66

def self.jsii_properties
  {
    :artifact_bounds => "artifactBounds",
    :category => "category",
    :provider => "provider",
    :action_properties => "actionProperties",
    :entity_url => "entityUrl",
    :execution_url => "executionUrl",
    :version => "version",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'codepipeline/custom_action_registration_props.rb', line 78

def to_jsii
  result = {}
  result.merge!({
    "artifactBounds" => @artifact_bounds,
    "category" => @category,
    "provider" => @provider,
    "actionProperties" => @action_properties,
    "entityUrl" => @entity_url,
    "executionUrl" => @execution_url,
    "version" => @version,
  })
  result.compact
end