cloudfront_cache_policy.md

permalink
/cloudfront_cache_policy/

cloudfront_cache_policy

cloudfront_cache_policy represents the aws_cloudfront_cache_policy Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withComment()
• fn withDefaultTtl()
• fn withMaxTtl()
• fn withMinTtl()
• fn withName()
• fn withParametersInCacheKeyAndForwardedToOrigin()
• fn withParametersInCacheKeyAndForwardedToOriginMixin()
• obj parameters_in_cache_key_and_forwarded_to_origin
  • fn new()
  • obj parameters_in_cache_key_and_forwarded_to_origin.cookies_config
    • fn new()
    • obj parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies
      • fn new()
  • obj parameters_in_cache_key_and_forwarded_to_origin.headers_config
    • fn new()
    • obj parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers
      • fn new()
  • obj parameters_in_cache_key_and_forwarded_to_origin.query_strings_config
    • fn new()
    • obj parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings
      • fn new()

Fields

fn new

new()

aws.cloudfront_cache_policy.new injects a new aws_cloudfront_cache_policy Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.cloudfront_cache_policy.new('some_id')

You can get the reference to the id field of the created aws.cloudfront_cache_policy using the reference:

$._ref.aws_cloudfront_cache_policy.some_id.get('id')

This is the same as directly entering "${ aws_cloudfront_cache_policy.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• comment (string): Set the comment field on the resulting resource block. When null, the comment field will be omitted from the resulting object.
• default_ttl (number): Set the default_ttl field on the resulting resource block. When null, the default_ttl field will be omitted from the resulting object.
• max_ttl (number): Set the max_ttl field on the resulting resource block. When null, the max_ttl field will be omitted from the resulting object.
• min_ttl (number): Set the min_ttl field on the resulting resource block. When null, the min_ttl field will be omitted from the resulting object.
• name (string): Set the name field on the resulting resource block.
• parameters_in_cache_key_and_forwarded_to_origin (list[obj]): Set the parameters_in_cache_key_and_forwarded_to_origin field on the resulting resource block. When null, the parameters_in_cache_key_and_forwarded_to_origin sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.cloudfront_cache_policy.newAttrs constructs a new object with attributes and blocks configured for the cloudfront_cache_policy Terraform resource.

Unlike aws.cloudfront_cache_policy.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• comment (string): Set the comment field on the resulting object. When null, the comment field will be omitted from the resulting object.
• default_ttl (number): Set the default_ttl field on the resulting object. When null, the default_ttl field will be omitted from the resulting object.
• max_ttl (number): Set the max_ttl field on the resulting object. When null, the max_ttl field will be omitted from the resulting object.
• min_ttl (number): Set the min_ttl field on the resulting object. When null, the min_ttl field will be omitted from the resulting object.
• name (string): Set the name field on the resulting object.
• parameters_in_cache_key_and_forwarded_to_origin (list[obj]): Set the parameters_in_cache_key_and_forwarded_to_origin field on the resulting object. When null, the parameters_in_cache_key_and_forwarded_to_origin sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new cloudfront_cache_policy resource into the root Terraform configuration.

fn withComment

withComment()

aws.string.withComment constructs a mixin object that can be merged into the string Terraform resource block to set or update the comment field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the comment field.

fn withDefaultTtl

withDefaultTtl()

aws.number.withDefaultTtl constructs a mixin object that can be merged into the number Terraform resource block to set or update the default_ttl field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the default_ttl field.

fn withMaxTtl

withMaxTtl()

aws.number.withMaxTtl constructs a mixin object that can be merged into the number Terraform resource block to set or update the max_ttl field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the max_ttl field.

fn withMinTtl

withMinTtl()

aws.number.withMinTtl constructs a mixin object that can be merged into the number Terraform resource block to set or update the min_ttl field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the min_ttl field.

fn withName

withName()

aws.string.withName constructs a mixin object that can be merged into the string Terraform resource block to set or update the name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the name field.

fn withParametersInCacheKeyAndForwardedToOrigin

withParametersInCacheKeyAndForwardedToOrigin()

aws.list[obj].withParametersInCacheKeyAndForwardedToOrigin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the parameters_in_cache_key_and_forwarded_to_origin field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withParametersInCacheKeyAndForwardedToOriginMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the parameters_in_cache_key_and_forwarded_to_origin field.

fn withParametersInCacheKeyAndForwardedToOriginMixin

withParametersInCacheKeyAndForwardedToOriginMixin()

aws.list[obj].withParametersInCacheKeyAndForwardedToOriginMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the parameters_in_cache_key_and_forwarded_to_origin field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withParametersInCacheKeyAndForwardedToOrigin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the parameters_in_cache_key_and_forwarded_to_origin field.

obj parameters_in_cache_key_and_forwarded_to_origin

fn parameters_in_cache_key_and_forwarded_to_origin.new

new()

aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.new constructs a new object with attributes and blocks configured for the parameters_in_cache_key_and_forwarded_to_origin Terraform sub block.

Args:

• enable_accept_encoding_brotli (bool): Set the enable_accept_encoding_brotli field on the resulting object. When null, the enable_accept_encoding_brotli field will be omitted from the resulting object.
• enable_accept_encoding_gzip (bool): Set the enable_accept_encoding_gzip field on the resulting object. When null, the enable_accept_encoding_gzip field will be omitted from the resulting object.
• cookies_config (list[obj]): Set the cookies_config field on the resulting object. When null, the cookies_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.new constructor.
• headers_config (list[obj]): Set the headers_config field on the resulting object. When null, the headers_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.headers_config.new constructor.
• query_strings_config (list[obj]): Set the query_strings_config field on the resulting object. When null, the query_strings_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.new constructor.

Returns:

• An attribute object that represents the parameters_in_cache_key_and_forwarded_to_origin sub block.

obj parameters_in_cache_key_and_forwarded_to_origin.cookies_config

fn parameters_in_cache_key_and_forwarded_to_origin.cookies_config.new

new()

aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.new constructs a new object with attributes and blocks configured for the cookies_config Terraform sub block.

Args:

• cookie_behavior (string): Set the cookie_behavior field on the resulting object.
• cookies (list[obj]): Set the cookies field on the resulting object. When null, the cookies sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.new constructor.

Returns:

• An attribute object that represents the cookies_config sub block.

obj parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies

fn parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.new

new()

aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.new constructs a new object with attributes and blocks configured for the cookies Terraform sub block.

Args:

• items (list): Set the items field on the resulting object. When null, the items field will be omitted from the resulting object.

Returns:

• An attribute object that represents the cookies sub block.

obj parameters_in_cache_key_and_forwarded_to_origin.headers_config

fn parameters_in_cache_key_and_forwarded_to_origin.headers_config.new

new()

aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.headers_config.new constructs a new object with attributes and blocks configured for the headers_config Terraform sub block.

Args:

• header_behavior (string): Set the header_behavior field on the resulting object. When null, the header_behavior field will be omitted from the resulting object.
• headers (list[obj]): Set the headers field on the resulting object. When null, the headers sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.new constructor.

Returns:

• An attribute object that represents the headers_config sub block.

obj parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers

fn parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.new

new()

aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.new constructs a new object with attributes and blocks configured for the headers Terraform sub block.

Args:

• items (list): Set the items field on the resulting object. When null, the items field will be omitted from the resulting object.

Returns:

• An attribute object that represents the headers sub block.

obj parameters_in_cache_key_and_forwarded_to_origin.query_strings_config

fn parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.new

new()

aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.new constructs a new object with attributes and blocks configured for the query_strings_config Terraform sub block.

Args:

• query_string_behavior (string): Set the query_string_behavior field on the resulting object.
• query_strings (list[obj]): Set the query_strings field on the resulting object. When null, the query_strings sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.new constructor.

Returns:

• An attribute object that represents the query_strings_config sub block.

obj parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings

fn parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.new

new()

aws.cloudfront_cache_policy.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.new constructs a new object with attributes and blocks configured for the query_strings Terraform sub block.

Args:

• items (list): Set the items field on the resulting object. When null, the items field will be omitted from the resulting object.

Returns:

• An attribute object that represents the query_strings sub block.