Class: AWSCDK::Pipelines::ManualApprovalStepProps

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

Overview

Construction properties for a ManualApprovalStep.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, notification_topic: nil, review_url: nil) ⇒ ManualApprovalStepProps

Returns a new instance of ManualApprovalStepProps.

Parameters:

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

    The comment to display with this manual approval.

  • notification_topic (AWSCDK::SNS::ITopic, nil) (defaults to: nil) —

    Optional SNS topic to send notifications to when an approval is pending.

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

    The URL for review associated with this manual approval.



10
11
12
13
14
15
16
17
 
# File 'pipelines/manual_approval_step_props.rb', line 10

def initialize(comment: nil, notification_topic: nil, review_url: nil)
  @comment = comment
  Jsii::Type.check_type(@comment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless @comment.nil?
  @notification_topic = notification_topic
  Jsii::Type.check_type(@notification_topic, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc25zLklUb3BpYyJ9")), "notificationTopic") unless @notification_topic.nil?
  @review_url = review_url
  Jsii::Type.check_type(@review_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "reviewUrl") unless @review_url.nil?
end

Instance Attribute Details

#comment ⇒ String? (readonly)

Note:

Default: - No comment

The comment to display with this manual approval.

Returns:

  • (String, nil) 


23
24
25
 
# File 'pipelines/manual_approval_step_props.rb', line 23

def comment
  @comment
end

#notification_topic ⇒ AWSCDK::SNS::ITopic? (readonly)

Note:

Default: - No notifications

Optional SNS topic to send notifications to when an approval is pending.

Returns:



28
29
30
 
# File 'pipelines/manual_approval_step_props.rb', line 28

def notification_topic
  @notification_topic
end

#review_url ⇒ String? (readonly)

Note:

Default: - No URL

The URL for review associated with this manual approval.

Returns:

  • (String, nil) 


33
34
35
 
# File 'pipelines/manual_approval_step_props.rb', line 33

def review_url
  @review_url
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
41
 
# File 'pipelines/manual_approval_step_props.rb', line 35

def self.jsii_properties
  {
    :comment => "comment",
    :notification_topic => "notificationTopic",
    :review_url => "reviewUrl",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'pipelines/manual_approval_step_props.rb', line 43

def to_jsii
  result = {}
  result.merge!({
    "comment" => @comment,
    "notificationTopic" => @notification_topic,
    "reviewUrl" => @review_url,
  })
  result.compact
end