Class: AWSCDK::Codepipeline::CfnWebhook::WebhookFilterRuleProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Codepipeline::CfnWebhook::WebhookFilterRuleProperty

Defined in:

codepipeline/cfn_webhook.rb

Overview

The event criteria that specify when a webhook notification is sent to your URL.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html

Instance Attribute Summary

• #json_path ⇒ String readonly

  A JsonPath expression that is applied to the body/payload of the webhook.

• #match_equals ⇒ String^? readonly

  The value selected by the JsonPath expression must match what is supplied in the MatchEquals field.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(json_path:, match_equals: nil) ⇒ WebhookFilterRuleProperty constructor

  A new instance of WebhookFilterRuleProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(json_path:, match_equals: nil) ⇒ WebhookFilterRuleProperty

Returns a new instance of WebhookFilterRuleProperty.

Parameters:

• json_path (String) —

  A JsonPath expression that is applied to the body/payload of the webhook.

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

  The value selected by the JsonPath expression must match what is supplied in the MatchEquals field.

# File 'codepipeline/cfn_webhook.rb', line 697

def initialize(json_path:, match_equals: nil)
  @json_path = json_path
  Jsii::Type.check_type(@json_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jsonPath")
  @match_equals = match_equals
  Jsii::Type.check_type(@match_equals, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "matchEquals") unless @match_equals.nil?
end

Instance Attribute Details

#json_path ⇒ String (readonly)

A JsonPath expression that is applied to the body/payload of the webhook.

The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-jsonpath

# File 'codepipeline/cfn_webhook.rb', line 710

def json_path
  @json_path
end

#match_equals ⇒ String^? (readonly)

The value selected by the JsonPath expression must match what is supplied in the MatchEquals field.

Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/Branch" and the target action has an action configuration property called "Branch" with a value of "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-matchequals

# File 'codepipeline/cfn_webhook.rb', line 717

def match_equals
  @match_equals
end

Class Method Details

.jsii_properties ⇒ Object

# File 'codepipeline/cfn_webhook.rb', line 719

def self.jsii_properties
  {
    :json_path => "jsonPath",
    :match_equals => "matchEquals",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'codepipeline/cfn_webhook.rb', line 726

def to_jsii
  result = {}
  result.merge!({
    "jsonPath" => @json_path,
    "matchEquals" => @match_equals,
  })
  result.compact
end