CfnDistribution

class aws_cdk.aws_cloudfront.CfnDistribution(scope, id, *, distribution_config, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::CloudFront::Distribution.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html cloudformationResource: :cloudformationResource:: AWS::CloudFront::Distribution

Create a new AWS::CloudFront::Distribution.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • distribution_config (Union[IResolvable, ForwardRef]) – AWS::CloudFront::Distribution.DistributionConfig.

  • tags (Optional[List[CfnTag]]) – AWS::CloudFront::Distribution.Tags.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

see :see:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

stability :stability: experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

return :rtype: str :return: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CloudFront::Distribution'
attr_domain_name

cloudformationAttribute: :cloudformationAttribute:: DomainName

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return :rtype: List[str] :return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

distribution_config

AWS::CloudFront::Distribution.DistributionConfig.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#cfn-cloudfront-distribution-distributionconfig

Return type

Union[IResolvable, ForwardRef]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

return :rtype: str :return:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::CloudFront::Distribution.Tags.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#cfn-cloudfront-distribution-tags

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

return :rtype: bool :return: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

CacheBehaviorProperty

class CfnDistribution.CacheBehaviorProperty(*, path_pattern, target_origin_id, viewer_protocol_policy, allowed_methods=None, cached_methods=None, cache_policy_id=None, compress=None, default_ttl=None, field_level_encryption_id=None, forwarded_values=None, lambda_function_associations=None, max_ttl=None, min_ttl=None, origin_request_policy_id=None, realtime_log_config_arn=None, smooth_streaming=None, trusted_signers=None)

Bases: object

Parameters
  • path_pattern (str) – CfnDistribution.CacheBehaviorProperty.PathPattern.

  • target_origin_id (str) – CfnDistribution.CacheBehaviorProperty.TargetOriginId.

  • viewer_protocol_policy (str) – CfnDistribution.CacheBehaviorProperty.ViewerProtocolPolicy.

  • allowed_methods (Optional[List[str]]) – CfnDistribution.CacheBehaviorProperty.AllowedMethods.

  • cached_methods (Optional[List[str]]) – CfnDistribution.CacheBehaviorProperty.CachedMethods.

  • cache_policy_id (Optional[str]) – CfnDistribution.CacheBehaviorProperty.CachePolicyId.

  • compress (Union[bool, IResolvable, None]) – CfnDistribution.CacheBehaviorProperty.Compress.

  • default_ttl (Union[int, float, None]) – CfnDistribution.CacheBehaviorProperty.DefaultTTL.

  • field_level_encryption_id (Optional[str]) – CfnDistribution.CacheBehaviorProperty.FieldLevelEncryptionId.

  • forwarded_values (Union[IResolvable, ForwardedValuesProperty, None]) – CfnDistribution.CacheBehaviorProperty.ForwardedValues.

  • lambda_function_associations (Union[IResolvable, List[Union[IResolvable, LambdaFunctionAssociationProperty]], None]) – CfnDistribution.CacheBehaviorProperty.LambdaFunctionAssociations.

  • max_ttl (Union[int, float, None]) – CfnDistribution.CacheBehaviorProperty.MaxTTL.

  • min_ttl (Union[int, float, None]) – CfnDistribution.CacheBehaviorProperty.MinTTL.

  • origin_request_policy_id (Optional[str]) – CfnDistribution.CacheBehaviorProperty.OriginRequestPolicyId.

  • realtime_log_config_arn (Optional[str]) – CfnDistribution.CacheBehaviorProperty.RealtimeLogConfigArn.

  • smooth_streaming (Union[bool, IResolvable, None]) – CfnDistribution.CacheBehaviorProperty.SmoothStreaming.

  • trusted_signers (Optional[List[str]]) – CfnDistribution.CacheBehaviorProperty.TrustedSigners.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html

Attributes

allowed_methods

CfnDistribution.CacheBehaviorProperty.AllowedMethods.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-allowedmethods

Return type

Optional[List[str]]

cache_policy_id

CfnDistribution.CacheBehaviorProperty.CachePolicyId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-cachepolicyid

Return type

Optional[str]

cached_methods

CfnDistribution.CacheBehaviorProperty.CachedMethods.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-cachedmethods

Return type

Optional[List[str]]

compress

CfnDistribution.CacheBehaviorProperty.Compress.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-compress

Return type

Union[bool, IResolvable, None]

default_ttl

CfnDistribution.CacheBehaviorProperty.DefaultTTL.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-defaultttl

Return type

Union[int, float, None]

field_level_encryption_id

CfnDistribution.CacheBehaviorProperty.FieldLevelEncryptionId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-fieldlevelencryptionid

Return type

Optional[str]

forwarded_values

CfnDistribution.CacheBehaviorProperty.ForwardedValues.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-forwardedvalues

Return type

Union[IResolvable, ForwardedValuesProperty, None]

lambda_function_associations

CfnDistribution.CacheBehaviorProperty.LambdaFunctionAssociations.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-lambdafunctionassociations

Return type

Union[IResolvable, List[Union[IResolvable, LambdaFunctionAssociationProperty]], None]

max_ttl

CfnDistribution.CacheBehaviorProperty.MaxTTL.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-maxttl

Return type

Union[int, float, None]

min_ttl

CfnDistribution.CacheBehaviorProperty.MinTTL.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-minttl

Return type

Union[int, float, None]

origin_request_policy_id

CfnDistribution.CacheBehaviorProperty.OriginRequestPolicyId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-originrequestpolicyid

Return type

Optional[str]

path_pattern

CfnDistribution.CacheBehaviorProperty.PathPattern.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-pathpattern

Return type

str

realtime_log_config_arn

CfnDistribution.CacheBehaviorProperty.RealtimeLogConfigArn.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-realtimelogconfigarn

Return type

Optional[str]

smooth_streaming

CfnDistribution.CacheBehaviorProperty.SmoothStreaming.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-smoothstreaming

Return type

Union[bool, IResolvable, None]

target_origin_id

CfnDistribution.CacheBehaviorProperty.TargetOriginId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-targetoriginid

Return type

str

trusted_signers

CfnDistribution.CacheBehaviorProperty.TrustedSigners.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-trustedsigners

Return type

Optional[List[str]]

viewer_protocol_policy

CfnDistribution.CacheBehaviorProperty.ViewerProtocolPolicy.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-viewerprotocolpolicy

Return type

str

CookiesProperty

class CfnDistribution.CookiesProperty(*, forward, whitelisted_names=None)

Bases: object

Parameters
  • forward (str) – CfnDistribution.CookiesProperty.Forward.

  • whitelisted_names (Optional[List[str]]) – CfnDistribution.CookiesProperty.WhitelistedNames.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html

Attributes

forward

CfnDistribution.CookiesProperty.Forward.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html#cfn-cloudfront-distribution-cookies-forward

Return type

str

whitelisted_names

CfnDistribution.CookiesProperty.WhitelistedNames.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html#cfn-cloudfront-distribution-cookies-whitelistednames

Return type

Optional[List[str]]

CustomErrorResponseProperty

class CfnDistribution.CustomErrorResponseProperty(*, error_code, error_caching_min_ttl=None, response_code=None, response_page_path=None)

Bases: object

Parameters
  • error_code (Union[int, float]) – CfnDistribution.CustomErrorResponseProperty.ErrorCode.

  • error_caching_min_ttl (Union[int, float, None]) – CfnDistribution.CustomErrorResponseProperty.ErrorCachingMinTTL.

  • response_code (Union[int, float, None]) – CfnDistribution.CustomErrorResponseProperty.ResponseCode.

  • response_page_path (Optional[str]) – CfnDistribution.CustomErrorResponseProperty.ResponsePagePath.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html

Attributes

error_caching_min_ttl

CfnDistribution.CustomErrorResponseProperty.ErrorCachingMinTTL.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-errorcachingminttl

Return type

Union[int, float, None]

error_code

CfnDistribution.CustomErrorResponseProperty.ErrorCode.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-errorcode

Return type

Union[int, float]

response_code

CfnDistribution.CustomErrorResponseProperty.ResponseCode.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsecode

Return type

Union[int, float, None]

response_page_path

CfnDistribution.CustomErrorResponseProperty.ResponsePagePath.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsepagepath

Return type

Optional[str]

CustomOriginConfigProperty

class CfnDistribution.CustomOriginConfigProperty(*, origin_protocol_policy, http_port=None, https_port=None, origin_keepalive_timeout=None, origin_read_timeout=None, origin_ssl_protocols=None)

Bases: object

Parameters
  • origin_protocol_policy (str) – CfnDistribution.CustomOriginConfigProperty.OriginProtocolPolicy.

  • http_port (Union[int, float, None]) – CfnDistribution.CustomOriginConfigProperty.HTTPPort.

  • https_port (Union[int, float, None]) – CfnDistribution.CustomOriginConfigProperty.HTTPSPort.

  • origin_keepalive_timeout (Union[int, float, None]) – CfnDistribution.CustomOriginConfigProperty.OriginKeepaliveTimeout.

  • origin_read_timeout (Union[int, float, None]) – CfnDistribution.CustomOriginConfigProperty.OriginReadTimeout.

  • origin_ssl_protocols (Optional[List[str]]) – CfnDistribution.CustomOriginConfigProperty.OriginSSLProtocols.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html

Attributes

http_port

CfnDistribution.CustomOriginConfigProperty.HTTPPort.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpport

Return type

Union[int, float, None]

https_port

CfnDistribution.CustomOriginConfigProperty.HTTPSPort.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpsport

Return type

Union[int, float, None]

origin_keepalive_timeout

CfnDistribution.CustomOriginConfigProperty.OriginKeepaliveTimeout.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originkeepalivetimeout

Return type

Union[int, float, None]

origin_protocol_policy

CfnDistribution.CustomOriginConfigProperty.OriginProtocolPolicy.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originprotocolpolicy

Return type

str

origin_read_timeout

CfnDistribution.CustomOriginConfigProperty.OriginReadTimeout.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originreadtimeout

Return type

Union[int, float, None]

origin_ssl_protocols

CfnDistribution.CustomOriginConfigProperty.OriginSSLProtocols.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originsslprotocols

Return type

Optional[List[str]]

DefaultCacheBehaviorProperty

class CfnDistribution.DefaultCacheBehaviorProperty(*, target_origin_id, viewer_protocol_policy, allowed_methods=None, cached_methods=None, cache_policy_id=None, compress=None, default_ttl=None, field_level_encryption_id=None, forwarded_values=None, lambda_function_associations=None, max_ttl=None, min_ttl=None, origin_request_policy_id=None, realtime_log_config_arn=None, smooth_streaming=None, trusted_signers=None)

Bases: object

Parameters
  • target_origin_id (str) – CfnDistribution.DefaultCacheBehaviorProperty.TargetOriginId.

  • viewer_protocol_policy (str) – CfnDistribution.DefaultCacheBehaviorProperty.ViewerProtocolPolicy.

  • allowed_methods (Optional[List[str]]) – CfnDistribution.DefaultCacheBehaviorProperty.AllowedMethods.

  • cached_methods (Optional[List[str]]) – CfnDistribution.DefaultCacheBehaviorProperty.CachedMethods.

  • cache_policy_id (Optional[str]) – CfnDistribution.DefaultCacheBehaviorProperty.CachePolicyId.

  • compress (Union[bool, IResolvable, None]) – CfnDistribution.DefaultCacheBehaviorProperty.Compress.

  • default_ttl (Union[int, float, None]) – CfnDistribution.DefaultCacheBehaviorProperty.DefaultTTL.

  • field_level_encryption_id (Optional[str]) – CfnDistribution.DefaultCacheBehaviorProperty.FieldLevelEncryptionId.

  • forwarded_values (Union[IResolvable, ForwardedValuesProperty, None]) – CfnDistribution.DefaultCacheBehaviorProperty.ForwardedValues.

  • lambda_function_associations (Union[IResolvable, List[Union[IResolvable, LambdaFunctionAssociationProperty]], None]) – CfnDistribution.DefaultCacheBehaviorProperty.LambdaFunctionAssociations.

  • max_ttl (Union[int, float, None]) – CfnDistribution.DefaultCacheBehaviorProperty.MaxTTL.

  • min_ttl (Union[int, float, None]) – CfnDistribution.DefaultCacheBehaviorProperty.MinTTL.

  • origin_request_policy_id (Optional[str]) – CfnDistribution.DefaultCacheBehaviorProperty.OriginRequestPolicyId.

  • realtime_log_config_arn (Optional[str]) – CfnDistribution.DefaultCacheBehaviorProperty.RealtimeLogConfigArn.

  • smooth_streaming (Union[bool, IResolvable, None]) – CfnDistribution.DefaultCacheBehaviorProperty.SmoothStreaming.

  • trusted_signers (Optional[List[str]]) – CfnDistribution.DefaultCacheBehaviorProperty.TrustedSigners.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html

Attributes

allowed_methods

CfnDistribution.DefaultCacheBehaviorProperty.AllowedMethods.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-allowedmethods

Return type

Optional[List[str]]

cache_policy_id

CfnDistribution.DefaultCacheBehaviorProperty.CachePolicyId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-cachepolicyid

Return type

Optional[str]

cached_methods

CfnDistribution.DefaultCacheBehaviorProperty.CachedMethods.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-cachedmethods

Return type

Optional[List[str]]

compress

CfnDistribution.DefaultCacheBehaviorProperty.Compress.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-compress

Return type

Union[bool, IResolvable, None]

default_ttl

CfnDistribution.DefaultCacheBehaviorProperty.DefaultTTL.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-defaultttl

Return type

Union[int, float, None]

field_level_encryption_id

CfnDistribution.DefaultCacheBehaviorProperty.FieldLevelEncryptionId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-fieldlevelencryptionid

Return type

Optional[str]

forwarded_values

CfnDistribution.DefaultCacheBehaviorProperty.ForwardedValues.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-forwardedvalues

Return type

Union[IResolvable, ForwardedValuesProperty, None]

lambda_function_associations

CfnDistribution.DefaultCacheBehaviorProperty.LambdaFunctionAssociations.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-lambdafunctionassociations

Return type

Union[IResolvable, List[Union[IResolvable, LambdaFunctionAssociationProperty]], None]

max_ttl

CfnDistribution.DefaultCacheBehaviorProperty.MaxTTL.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-maxttl

Return type

Union[int, float, None]

min_ttl

CfnDistribution.DefaultCacheBehaviorProperty.MinTTL.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-minttl

Return type

Union[int, float, None]

origin_request_policy_id

CfnDistribution.DefaultCacheBehaviorProperty.OriginRequestPolicyId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-originrequestpolicyid

Return type

Optional[str]

realtime_log_config_arn

CfnDistribution.DefaultCacheBehaviorProperty.RealtimeLogConfigArn.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-realtimelogconfigarn

Return type

Optional[str]

smooth_streaming

CfnDistribution.DefaultCacheBehaviorProperty.SmoothStreaming.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-smoothstreaming

Return type

Union[bool, IResolvable, None]

target_origin_id

CfnDistribution.DefaultCacheBehaviorProperty.TargetOriginId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-targetoriginid

Return type

str

trusted_signers

CfnDistribution.DefaultCacheBehaviorProperty.TrustedSigners.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-trustedsigners

Return type

Optional[List[str]]

viewer_protocol_policy

CfnDistribution.DefaultCacheBehaviorProperty.ViewerProtocolPolicy.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-viewerprotocolpolicy

Return type

str

DistributionConfigProperty

class CfnDistribution.DistributionConfigProperty(*, enabled, aliases=None, cache_behaviors=None, comment=None, custom_error_responses=None, default_cache_behavior=None, default_root_object=None, http_version=None, ipv6_enabled=None, logging=None, origin_groups=None, origins=None, price_class=None, restrictions=None, viewer_certificate=None, web_acl_id=None)

Bases: object

Parameters
  • enabled (Union[bool, IResolvable]) – CfnDistribution.DistributionConfigProperty.Enabled.

  • aliases (Optional[List[str]]) – CfnDistribution.DistributionConfigProperty.Aliases.

  • cache_behaviors (Union[IResolvable, List[Union[IResolvable, CacheBehaviorProperty]], None]) – CfnDistribution.DistributionConfigProperty.CacheBehaviors.

  • comment (Optional[str]) – CfnDistribution.DistributionConfigProperty.Comment.

  • custom_error_responses (Union[IResolvable, List[Union[IResolvable, CustomErrorResponseProperty]], None]) – CfnDistribution.DistributionConfigProperty.CustomErrorResponses.

  • default_cache_behavior (Union[IResolvable, DefaultCacheBehaviorProperty, None]) – CfnDistribution.DistributionConfigProperty.DefaultCacheBehavior.

  • default_root_object (Optional[str]) – CfnDistribution.DistributionConfigProperty.DefaultRootObject.

  • http_version (Optional[str]) – CfnDistribution.DistributionConfigProperty.HttpVersion.

  • ipv6_enabled (Union[bool, IResolvable, None]) – CfnDistribution.DistributionConfigProperty.IPV6Enabled.

  • logging (Union[IResolvable, LoggingProperty, None]) – CfnDistribution.DistributionConfigProperty.Logging.

  • origin_groups (Union[IResolvable, OriginGroupsProperty, None]) – CfnDistribution.DistributionConfigProperty.OriginGroups.

  • origins (Union[IResolvable, List[Union[OriginProperty, IResolvable]], None]) – CfnDistribution.DistributionConfigProperty.Origins.

  • price_class (Optional[str]) – CfnDistribution.DistributionConfigProperty.PriceClass.

  • restrictions (Union[IResolvable, RestrictionsProperty, None]) – CfnDistribution.DistributionConfigProperty.Restrictions.

  • viewer_certificate (Union[IResolvable, ViewerCertificateProperty, None]) – CfnDistribution.DistributionConfigProperty.ViewerCertificate.

  • web_acl_id (Optional[str]) – CfnDistribution.DistributionConfigProperty.WebACLId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html

Attributes

aliases

CfnDistribution.DistributionConfigProperty.Aliases.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-aliases

Return type

Optional[List[str]]

cache_behaviors

CfnDistribution.DistributionConfigProperty.CacheBehaviors.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-cachebehaviors

Return type

Union[IResolvable, List[Union[IResolvable, CacheBehaviorProperty]], None]

comment

CfnDistribution.DistributionConfigProperty.Comment.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-comment

Return type

Optional[str]

custom_error_responses

CfnDistribution.DistributionConfigProperty.CustomErrorResponses.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-customerrorresponses

Return type

Union[IResolvable, List[Union[IResolvable, CustomErrorResponseProperty]], None]

default_cache_behavior

CfnDistribution.DistributionConfigProperty.DefaultCacheBehavior.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-defaultcachebehavior

Return type

Union[IResolvable, DefaultCacheBehaviorProperty, None]

default_root_object

CfnDistribution.DistributionConfigProperty.DefaultRootObject.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-defaultrootobject

Return type

Optional[str]

enabled

CfnDistribution.DistributionConfigProperty.Enabled.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-enabled

Return type

Union[bool, IResolvable]

http_version

CfnDistribution.DistributionConfigProperty.HttpVersion.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-httpversion

Return type

Optional[str]

ipv6_enabled

CfnDistribution.DistributionConfigProperty.IPV6Enabled.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-ipv6enabled

Return type

Union[bool, IResolvable, None]

logging

CfnDistribution.DistributionConfigProperty.Logging.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-logging

Return type

Union[IResolvable, LoggingProperty, None]

origin_groups

CfnDistribution.DistributionConfigProperty.OriginGroups.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-origingroups

Return type

Union[IResolvable, OriginGroupsProperty, None]

origins

CfnDistribution.DistributionConfigProperty.Origins.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-origins

Return type

Union[IResolvable, List[Union[OriginProperty, IResolvable]], None]

price_class

CfnDistribution.DistributionConfigProperty.PriceClass.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-priceclass

Return type

Optional[str]

restrictions

CfnDistribution.DistributionConfigProperty.Restrictions.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions

Return type

Union[IResolvable, RestrictionsProperty, None]

viewer_certificate

CfnDistribution.DistributionConfigProperty.ViewerCertificate.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-viewercertificate

Return type

Union[IResolvable, ViewerCertificateProperty, None]

web_acl_id

CfnDistribution.DistributionConfigProperty.WebACLId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-webaclid

Return type

Optional[str]

ForwardedValuesProperty

class CfnDistribution.ForwardedValuesProperty(*, query_string, cookies=None, headers=None, query_string_cache_keys=None)

Bases: object

Parameters
  • query_string (Union[bool, IResolvable]) – CfnDistribution.ForwardedValuesProperty.QueryString.

  • cookies (Union[IResolvable, CookiesProperty, None]) – CfnDistribution.ForwardedValuesProperty.Cookies.

  • headers (Optional[List[str]]) – CfnDistribution.ForwardedValuesProperty.Headers.

  • query_string_cache_keys (Optional[List[str]]) – CfnDistribution.ForwardedValuesProperty.QueryStringCacheKeys.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html

Attributes

cookies

CfnDistribution.ForwardedValuesProperty.Cookies.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-cookies

Return type

Union[IResolvable, CookiesProperty, None]

headers

CfnDistribution.ForwardedValuesProperty.Headers.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-headers

Return type

Optional[List[str]]

query_string

CfnDistribution.ForwardedValuesProperty.QueryString.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-querystring

Return type

Union[bool, IResolvable]

query_string_cache_keys

CfnDistribution.ForwardedValuesProperty.QueryStringCacheKeys.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-querystringcachekeys

Return type

Optional[List[str]]

GeoRestrictionProperty

class CfnDistribution.GeoRestrictionProperty(*, restriction_type, locations=None)

Bases: object

Parameters
  • restriction_type (str) – CfnDistribution.GeoRestrictionProperty.RestrictionType.

  • locations (Optional[List[str]]) – CfnDistribution.GeoRestrictionProperty.Locations.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html

Attributes

locations

CfnDistribution.GeoRestrictionProperty.Locations.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-locations

Return type

Optional[List[str]]

restriction_type

CfnDistribution.GeoRestrictionProperty.RestrictionType.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-restrictiontype

Return type

str

LambdaFunctionAssociationProperty

class CfnDistribution.LambdaFunctionAssociationProperty(*, event_type=None, include_body=None, lambda_function_arn=None)

Bases: object

Parameters
  • event_type (Optional[str]) – CfnDistribution.LambdaFunctionAssociationProperty.EventType.

  • include_body (Union[bool, IResolvable, None]) – CfnDistribution.LambdaFunctionAssociationProperty.IncludeBody.

  • lambda_function_arn (Optional[str]) – CfnDistribution.LambdaFunctionAssociationProperty.LambdaFunctionARN.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html

Attributes

event_type

CfnDistribution.LambdaFunctionAssociationProperty.EventType.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-eventtype

Return type

Optional[str]

include_body

CfnDistribution.LambdaFunctionAssociationProperty.IncludeBody.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-includebody

Return type

Union[bool, IResolvable, None]

lambda_function_arn

CfnDistribution.LambdaFunctionAssociationProperty.LambdaFunctionARN.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-lambdafunctionarn

Return type

Optional[str]

LoggingProperty

class CfnDistribution.LoggingProperty(*, bucket, include_cookies=None, prefix=None)

Bases: object

Parameters
  • bucket (str) – CfnDistribution.LoggingProperty.Bucket.

  • include_cookies (Union[bool, IResolvable, None]) – CfnDistribution.LoggingProperty.IncludeCookies.

  • prefix (Optional[str]) – CfnDistribution.LoggingProperty.Prefix.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html

Attributes

bucket

CfnDistribution.LoggingProperty.Bucket.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-bucket

Return type

str

include_cookies

CfnDistribution.LoggingProperty.IncludeCookies.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-includecookies

Return type

Union[bool, IResolvable, None]

prefix

CfnDistribution.LoggingProperty.Prefix.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-prefix

Return type

Optional[str]

OriginCustomHeaderProperty

class CfnDistribution.OriginCustomHeaderProperty(*, header_name, header_value)

Bases: object

Parameters
  • header_name (str) – CfnDistribution.OriginCustomHeaderProperty.HeaderName.

  • header_value (str) – CfnDistribution.OriginCustomHeaderProperty.HeaderValue.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html

Attributes

header_name

CfnDistribution.OriginCustomHeaderProperty.HeaderName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html#cfn-cloudfront-distribution-origincustomheader-headername

Return type

str

header_value

CfnDistribution.OriginCustomHeaderProperty.HeaderValue.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html#cfn-cloudfront-distribution-origincustomheader-headervalue

Return type

str

OriginGroupFailoverCriteriaProperty

class CfnDistribution.OriginGroupFailoverCriteriaProperty(*, status_codes)

Bases: object

Parameters

status_codes (Union[IResolvable, StatusCodesProperty]) – CfnDistribution.OriginGroupFailoverCriteriaProperty.StatusCodes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupfailovercriteria.html

Attributes

status_codes

CfnDistribution.OriginGroupFailoverCriteriaProperty.StatusCodes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupfailovercriteria.html#cfn-cloudfront-distribution-origingroupfailovercriteria-statuscodes

Return type

Union[IResolvable, StatusCodesProperty]

OriginGroupMemberProperty

class CfnDistribution.OriginGroupMemberProperty(*, origin_id)

Bases: object

Parameters

origin_id (str) – CfnDistribution.OriginGroupMemberProperty.OriginId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmember.html

Attributes

origin_id

CfnDistribution.OriginGroupMemberProperty.OriginId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmember.html#cfn-cloudfront-distribution-origingroupmember-originid

Return type

str

OriginGroupMembersProperty

class CfnDistribution.OriginGroupMembersProperty(*, items, quantity)

Bases: object

Parameters

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmembers.html

Attributes

items

CfnDistribution.OriginGroupMembersProperty.Items.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmembers.html#cfn-cloudfront-distribution-origingroupmembers-items

Return type

Union[IResolvable, List[Union[IResolvable, OriginGroupMemberProperty]]]

quantity

CfnDistribution.OriginGroupMembersProperty.Quantity.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmembers.html#cfn-cloudfront-distribution-origingroupmembers-quantity

Return type

Union[int, float]

OriginGroupProperty

class CfnDistribution.OriginGroupProperty(*, failover_criteria, id, members)

Bases: object

Parameters

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html

Attributes

failover_criteria

CfnDistribution.OriginGroupProperty.FailoverCriteria.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-failovercriteria

Return type

Union[IResolvable, OriginGroupFailoverCriteriaProperty]

id

CfnDistribution.OriginGroupProperty.Id.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-id

Return type

str

members

CfnDistribution.OriginGroupProperty.Members.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-members

Return type

Union[IResolvable, OriginGroupMembersProperty]

OriginGroupsProperty

class CfnDistribution.OriginGroupsProperty(*, quantity, items=None)

Bases: object

Parameters
  • quantity (Union[int, float]) – CfnDistribution.OriginGroupsProperty.Quantity.

  • items (Union[IResolvable, List[Union[IResolvable, OriginGroupProperty]], None]) – CfnDistribution.OriginGroupsProperty.Items.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroups.html

Attributes

items

CfnDistribution.OriginGroupsProperty.Items.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroups.html#cfn-cloudfront-distribution-origingroups-items

Return type

Union[IResolvable, List[Union[IResolvable, OriginGroupProperty]], None]

quantity

CfnDistribution.OriginGroupsProperty.Quantity.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroups.html#cfn-cloudfront-distribution-origingroups-quantity

Return type

Union[int, float]

OriginProperty

class CfnDistribution.OriginProperty(*, domain_name, id, connection_attempts=None, connection_timeout=None, custom_origin_config=None, origin_custom_headers=None, origin_path=None, s3_origin_config=None)

Bases: object

Parameters
  • domain_name (str) – CfnDistribution.OriginProperty.DomainName.

  • id (str) – CfnDistribution.OriginProperty.Id.

  • connection_attempts (Union[int, float, None]) – CfnDistribution.OriginProperty.ConnectionAttempts.

  • connection_timeout (Union[int, float, None]) – CfnDistribution.OriginProperty.ConnectionTimeout.

  • custom_origin_config (Union[IResolvable, CustomOriginConfigProperty, None]) – CfnDistribution.OriginProperty.CustomOriginConfig.

  • origin_custom_headers (Union[IResolvable, List[Union[IResolvable, OriginCustomHeaderProperty]], None]) – CfnDistribution.OriginProperty.OriginCustomHeaders.

  • origin_path (Optional[str]) – CfnDistribution.OriginProperty.OriginPath.

  • s3_origin_config (Union[IResolvable, S3OriginConfigProperty, None]) – CfnDistribution.OriginProperty.S3OriginConfig.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html

Attributes

connection_attempts

CfnDistribution.OriginProperty.ConnectionAttempts.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-connectionattempts

Return type

Union[int, float, None]

connection_timeout

CfnDistribution.OriginProperty.ConnectionTimeout.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-connectiontimeout

Return type

Union[int, float, None]

custom_origin_config

CfnDistribution.OriginProperty.CustomOriginConfig.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-customoriginconfig

Return type

Union[IResolvable, CustomOriginConfigProperty, None]

domain_name

CfnDistribution.OriginProperty.DomainName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-domainname

Return type

str

id

CfnDistribution.OriginProperty.Id.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-id

Return type

str

origin_custom_headers

CfnDistribution.OriginProperty.OriginCustomHeaders.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-origincustomheaders

Return type

Union[IResolvable, List[Union[IResolvable, OriginCustomHeaderProperty]], None]

origin_path

CfnDistribution.OriginProperty.OriginPath.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-originpath

Return type

Optional[str]

s3_origin_config

CfnDistribution.OriginProperty.S3OriginConfig.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-s3originconfig

Return type

Union[IResolvable, S3OriginConfigProperty, None]

RestrictionsProperty

class CfnDistribution.RestrictionsProperty(*, geo_restriction)

Bases: object

Parameters

geo_restriction (Union[IResolvable, GeoRestrictionProperty]) – CfnDistribution.RestrictionsProperty.GeoRestriction.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-restrictions.html

Attributes

geo_restriction

CfnDistribution.RestrictionsProperty.GeoRestriction.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-restrictions.html#cfn-cloudfront-distribution-restrictions-georestriction

Return type

Union[IResolvable, GeoRestrictionProperty]

S3OriginConfigProperty

class CfnDistribution.S3OriginConfigProperty(*, origin_access_identity=None)

Bases: object

Parameters

origin_access_identity (Optional[str]) – CfnDistribution.S3OriginConfigProperty.OriginAccessIdentity.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-s3originconfig.html

Attributes

origin_access_identity

CfnDistribution.S3OriginConfigProperty.OriginAccessIdentity.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-s3originconfig.html#cfn-cloudfront-distribution-s3originconfig-originaccessidentity

Return type

Optional[str]

StatusCodesProperty

class CfnDistribution.StatusCodesProperty(*, items, quantity)

Bases: object

Parameters
  • items (Union[IResolvable, List[Union[int, float]]]) – CfnDistribution.StatusCodesProperty.Items.

  • quantity (Union[int, float]) – CfnDistribution.StatusCodesProperty.Quantity.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-statuscodes.html

Attributes

items

CfnDistribution.StatusCodesProperty.Items.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-statuscodes.html#cfn-cloudfront-distribution-statuscodes-items

Return type

Union[IResolvable, List[Union[int, float]]]

quantity

CfnDistribution.StatusCodesProperty.Quantity.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-statuscodes.html#cfn-cloudfront-distribution-statuscodes-quantity

Return type

Union[int, float]

ViewerCertificateProperty

class CfnDistribution.ViewerCertificateProperty(*, acm_certificate_arn=None, cloud_front_default_certificate=None, iam_certificate_id=None, minimum_protocol_version=None, ssl_support_method=None)

Bases: object

Parameters
  • acm_certificate_arn (Optional[str]) – CfnDistribution.ViewerCertificateProperty.AcmCertificateArn.

  • cloud_front_default_certificate (Union[bool, IResolvable, None]) – CfnDistribution.ViewerCertificateProperty.CloudFrontDefaultCertificate.

  • iam_certificate_id (Optional[str]) – CfnDistribution.ViewerCertificateProperty.IamCertificateId.

  • minimum_protocol_version (Optional[str]) – CfnDistribution.ViewerCertificateProperty.MinimumProtocolVersion.

  • ssl_support_method (Optional[str]) – CfnDistribution.ViewerCertificateProperty.SslSupportMethod.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html

Attributes

acm_certificate_arn

CfnDistribution.ViewerCertificateProperty.AcmCertificateArn.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-acmcertificatearn

Return type

Optional[str]

cloud_front_default_certificate

CfnDistribution.ViewerCertificateProperty.CloudFrontDefaultCertificate.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-cloudfrontdefaultcertificate

Return type

Union[bool, IResolvable, None]

iam_certificate_id

CfnDistribution.ViewerCertificateProperty.IamCertificateId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-iamcertificateid

Return type

Optional[str]

minimum_protocol_version

CfnDistribution.ViewerCertificateProperty.MinimumProtocolVersion.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-minimumprotocolversion

Return type

Optional[str]

ssl_support_method

CfnDistribution.ViewerCertificateProperty.SslSupportMethod.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-sslsupportmethod

Return type

Optional[str]