Class: AWSCDK::WAFv2::CfnWebACL::FieldToProtectProperty

Inherits:

Jsii::Struct

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

Defined in:

wa_fv2/cfn_web_acl.rb

Overview

Specifies a field type and keys to protect in stored web request data.

This is part of the data protection configuration for a web ACL.

See Also:

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

Instance Attribute Summary

• #field_keys ⇒ Array<String>^? readonly

  Specifies the keys to protect for the specified field type.

• #field_type ⇒ String readonly

  Specifies the web request component type to protect.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_type:, field_keys: nil) ⇒ FieldToProtectProperty constructor

  A new instance of FieldToProtectProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_type:, field_keys: nil) ⇒ FieldToProtectProperty

Returns a new instance of FieldToProtectProperty.

Parameters:

• field_type (String) —

  Specifies the web request component type to protect.

• field_keys (Array<String>, nil) (defaults to: nil) —

  Specifies the keys to protect for the specified field type.

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

def initialize(field_type:, field_keys: nil)
  @field_type = field_type
  Jsii::Type.check_type(@field_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldType")
  @field_keys = field_keys
  Jsii::Type.check_type(@field_keys, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "fieldKeys") unless @field_keys.nil?
end

Instance Attribute Details

#field_keys ⇒ Array<String>^? (readonly)

Specifies the keys to protect for the specified field type.

If you don't specify any key, then all keys for the field type are protected.

Returns:

• (Array<String>, nil)

See Also:

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

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

def field_keys
  @field_keys
end

#field_type ⇒ String (readonly)

Specifies the web request component type to protect.

Returns:

• (String)

See Also:

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

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

def field_type
  @field_type
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :field_type => "fieldType",
    :field_keys => "fieldKeys",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "fieldType" => @field_type,
    "fieldKeys" => @field_keys,
  })
  result.compact
end