Class: AWSCDK::Codepipeline::CustomActionProperty

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

Overview

The creation attributes used for defining a configuration property of a custom Action.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, required:, description: nil, key: nil, queryable: nil, secret: nil, type: nil) ⇒ CustomActionProperty

Returns a new instance of CustomActionProperty.

Parameters:

  • name (String) —

    The name of the property.

  • required (Boolean) —

    Whether this property is required.

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

    The description of the property.

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

    Whether this property is a key.

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

    Whether this property is queryable.

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

    Whether this property is secret, like a password, or access key.

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

    The type of the property, like 'String', 'Number', or 'Boolean'.



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

def initialize(name:, required:, description: nil, key: nil, queryable: nil, secret: nil, type: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @required = required
  Jsii::Type.check_type(@required, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "required")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "key") unless @key.nil?
  @queryable = queryable
  Jsii::Type.check_type(@queryable, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "queryable") unless @queryable.nil?
  @secret = secret
  Jsii::Type.check_type(@secret, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "secret") unless @secret.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Note:

Default: the description will be empty

The description of the property.

Returns:

  • (String, nil) 


45
46
47
 
# File 'codepipeline/custom_action_property.rb', line 45

def description
  @description
end

#key ⇒ Boolean? (readonly)

Note:

Default: false

Whether this property is a key.

Returns:

  • (Boolean, nil)

See Also:



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

def key
  @key
end

#name ⇒ String (readonly)

The name of the property.

You use this name in the configuration attribute when defining your custom Action class.

Returns:

  • (String) 


36
37
38
 
# File 'codepipeline/custom_action_property.rb', line 36

def name
  @name
end

#queryable ⇒ Boolean? (readonly)

Note:

Default: false

Whether this property is queryable.

Note that only a single property of a custom Action can be queryable.

Returns:

  • (Boolean, nil)

See Also:



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

def queryable
  @queryable
end

#required ⇒ Boolean (readonly)

Whether this property is required.

Returns:

  • (Boolean) 


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

def required
  @required
end

#secret ⇒ Boolean? (readonly)

Note:

Default: false

Whether this property is secret, like a password, or access key.

Returns:

  • (Boolean, nil) 


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

def secret
  @secret
end

#type ⇒ String? (readonly)

Note:

Default: 'String'

The type of the property, like 'String', 'Number', or 'Boolean'.

Returns:

  • (String, nil) 


69
70
71
 
# File 'codepipeline/custom_action_property.rb', line 69

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'codepipeline/custom_action_property.rb', line 71

def self.jsii_properties
  {
    :name => "name",
    :required => "required",
    :description => "description",
    :key => "key",
    :queryable => "queryable",
    :secret => "secret",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'codepipeline/custom_action_property.rb', line 83

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "required" => @required,
    "description" => @description,
    "key" => @key,
    "queryable" => @queryable,
    "secret" => @secret,
    "type" => @type,
  })
  result.compact
end