Class: AWSCDK::AppConfig::ActionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_config/action_props.rb

Overview

Properties for the Action construct.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_points:, event_destination:, description: nil, execution_role: nil, invoke_without_execution_role: nil, name: nil) ⇒ ActionProps

Returns a new instance of ActionProps.

Parameters:

  • action_points (Array<AWSCDK::AppConfig::ActionPoint>) —

    The action points that will trigger the extension action.

  • event_destination (AWSCDK::AppConfig::IEventDestination) —

    The event destination for the action.

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

    The description for the action.

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

    The execution role for the action.

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

    The flag that specifies whether or not to create the execution role.

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

    The name for the action.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'app_config/action_props.rb', line 13

def initialize(action_points:, event_destination:, description: nil, execution_role: nil, invoke_without_execution_role: nil, name: nil)
  @action_points = action_points
  Jsii::Type.check_type(@action_points, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBjb25maWcuQWN0aW9uUG9pbnQifSwia2luZCI6ImFycmF5In19")), "actionPoints")
  @event_destination = event_destination
  Jsii::Type.check_type(@event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @execution_role = execution_role
  Jsii::Type.check_type(@execution_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "executionRole") unless @execution_role.nil?
  @invoke_without_execution_role = invoke_without_execution_role
  Jsii::Type.check_type(@invoke_without_execution_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "invokeWithoutExecutionRole") unless @invoke_without_execution_role.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
end

Instance Attribute Details

#action_points ⇒ Array<AWSCDK::AppConfig::ActionPoint> (readonly)

The action points that will trigger the extension action.

Returns:



31
32
33
 
# File 'app_config/action_props.rb', line 31

def action_points
  @action_points
end

#description ⇒ String? (readonly)

Note:

Default: - No description.

The description for the action.

Returns:

  • (String, nil) 


40
41
42
 
# File 'app_config/action_props.rb', line 40

def description
  @description
end

#event_destination ⇒ AWSCDK::AppConfig::IEventDestination (readonly)

The event destination for the action.

Returns:



35
36
37
 
# File 'app_config/action_props.rb', line 35

def event_destination
  @event_destination
end

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

Note:

Default: - A role is generated.

The execution role for the action.

Returns:



45
46
47
 
# File 'app_config/action_props.rb', line 45

def execution_role
  @execution_role
end

#invoke_without_execution_role ⇒ Boolean? (readonly)

Note:

Default: false

The flag that specifies whether or not to create the execution role.

If set to true, then the role will not be auto-generated under the assumption there is already the corresponding resource-based policy attached to the event destination. If false, the execution role will be generated if not provided.

Returns:

  • (Boolean, nil) 


54
55
56
 
# File 'app_config/action_props.rb', line 54

def invoke_without_execution_role
  @invoke_without_execution_role
end

#name ⇒ String? (readonly)

Note:

Default: - A name is generated.

The name for the action.

Returns:

  • (String, nil) 


59
60
61
 
# File 'app_config/action_props.rb', line 59

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'app_config/action_props.rb', line 61

def self.jsii_properties
  {
    :action_points => "actionPoints",
    :event_destination => "eventDestination",
    :description => "description",
    :execution_role => "executionRole",
    :invoke_without_execution_role => "invokeWithoutExecutionRole",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'app_config/action_props.rb', line 72

def to_jsii
  result = {}
  result.merge!({
    "actionPoints" => @action_points,
    "eventDestination" => @event_destination,
    "description" => @description,
    "executionRole" => @execution_role,
    "invokeWithoutExecutionRole" => @invoke_without_execution_role,
    "name" => @name,
  })
  result.compact
end