Class: AWSCDK::Lightsail::CfnDistribution::QueryStringObjectProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Lightsail::CfnDistribution::QueryStringObjectProperty

Defined in:

lightsail/cfn_distribution.rb

Overview

QueryStringObject is a property of the CacheSettings property. It describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html

Instance Attribute Summary

• #option ⇒ Boolean, ... readonly

  Indicates whether the distribution forwards and caches based on query strings.

• #query_strings_allow_list ⇒ Array<String>^? readonly

  The specific query strings that the distribution forwards to the origin.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(option: nil, query_strings_allow_list: nil) ⇒ QueryStringObjectProperty constructor

  A new instance of QueryStringObjectProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(option: nil, query_strings_allow_list: nil) ⇒ QueryStringObjectProperty

Returns a new instance of QueryStringObjectProperty.

Parameters:

• option (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  Indicates whether the distribution forwards and caches based on query strings.

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

  The specific query strings that the distribution forwards to the origin.

# File 'lightsail/cfn_distribution.rb', line 1065

def initialize(option: nil, query_strings_allow_list: nil)
  @option = option
  Jsii::Type.check_type(@option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "option") unless @option.nil?
  @query_strings_allow_list = query_strings_allow_list
  Jsii::Type.check_type(@query_strings_allow_list, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "queryStringsAllowList") unless @query_strings_allow_list.nil?
end

Instance Attribute Details

#option ⇒ Boolean, ... (readonly)

Indicates whether the distribution forwards and caches based on query strings.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html#cfn-lightsail-distribution-querystringobject-option

# File 'lightsail/cfn_distribution.rb', line 1076

def option
  @option
end

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

The specific query strings that the distribution forwards to the origin.

Your distribution caches content based on the specified query strings.

If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the QueryStringsAllowList parameter.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html#cfn-lightsail-distribution-querystringobject-querystringsallowlist

# File 'lightsail/cfn_distribution.rb', line 1085

def query_strings_allow_list
  @query_strings_allow_list
end

Class Method Details

.jsii_properties ⇒ Object

# File 'lightsail/cfn_distribution.rb', line 1087

def self.jsii_properties
  {
    :option => "option",
    :query_strings_allow_list => "queryStringsAllowList",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'lightsail/cfn_distribution.rb', line 1094

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