Class: AWSCDK::WAFv2::CfnWebACL::CustomHTTPHeaderProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::WAFv2::CfnWebACL::CustomHTTPHeaderProperty

Defined in:

wa_fv2/cfn_web_acl.rb

Overview

A custom header for custom request and response handling.

This is used in CustomResponse and CustomRequestHandling .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customhttpheader.html

Instance Attribute Summary

• #name ⇒ String readonly

  The name of the custom header.

• #value ⇒ String readonly

  The value of the custom header.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, value:) ⇒ CustomHTTPHeaderProperty constructor

  A new instance of CustomHTTPHeaderProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, value:) ⇒ CustomHTTPHeaderProperty

Returns a new instance of CustomHTTPHeaderProperty.

Parameters:

• name (String) —

  The name of the custom header.

• value (String) —

  The value of the custom header.

# File 'wa_fv2/cfn_web_acl.rb', line 2002

def initialize(name:, value:)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
end

Instance Attribute Details

#name ⇒ String (readonly)

The name of the custom header.

For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , AWS WAF inserts the header x-amzn-waf-sample .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customhttpheader.html#cfn-wafv2-webacl-customhttpheader-name

# File 'wa_fv2/cfn_web_acl.rb', line 2015

def name
  @name
end

#value ⇒ String (readonly)

The value of the custom header.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customhttpheader.html#cfn-wafv2-webacl-customhttpheader-value

# File 'wa_fv2/cfn_web_acl.rb', line 2020

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'wa_fv2/cfn_web_acl.rb', line 2022

def self.jsii_properties
  {
    :name => "name",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'wa_fv2/cfn_web_acl.rb', line 2029

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "value" => @value,
  })
  result.compact
end