Class: AWSCDK::WAFv2::CfnWebACL::FieldIdentifierProperty

Inherits:

Jsii::Struct

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

Defined in:

wa_fv2/cfn_web_acl.rb

Overview

The identifier of a field in the web request payload that contains customer data.

This data type is used to specify fields in the RequestInspection and RequestInspectionACFP configurations, which are used in the managed rule group configurations AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet , respectively.

See Also:

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

Instance Attribute Summary

• #identifier ⇒ String readonly

  The name of the field.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(identifier:) ⇒ FieldIdentifierProperty constructor

  A new instance of FieldIdentifierProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(identifier:) ⇒ FieldIdentifierProperty

Returns a new instance of FieldIdentifierProperty.

Parameters:

• identifier (String) —

  The name of the field.

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

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

Instance Attribute Details

#identifier ⇒ String (readonly)

The name of the field.

When the PayloadType in the request inspection is JSON , this identifier must be in JSON pointer syntax. For example /form/username . For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

When the PayloadType is FORM_ENCODED , use the HTML form names. For example, username .

For more information, see the descriptions for each field type in the request inspection properties.

Returns:

• (String)

See Also:

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

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

def identifier
  @identifier
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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