OriginBindConfig

class aws_cdk.aws_cloudfront.OriginBindConfig(*, failover_config=None, origin_property=None)

Bases: object

The struct returned from {@link IOrigin.bind}.

Parameters
  • failover_config (Optional[OriginFailoverConfig]) – The failover configuration for this Origin. Default: - nothing is returned

  • origin_property (Optional[OriginProperty]) – The CloudFormation OriginProperty configuration for this Origin. Default: - nothing is returned

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloudfront as cloudfront

# origin: cloudfront.IOrigin

origin_bind_config = cloudfront.OriginBindConfig(
    failover_config=cloudfront.OriginFailoverConfig(
        failover_origin=origin,

        # the properties below are optional
        status_codes=[123]
    ),
    origin_property=cloudfront.CfnDistribution.OriginProperty(
        domain_name="domainName",
        id="id",

        # the properties below are optional
        connection_attempts=123,
        connection_timeout=123,
        custom_origin_config=cloudfront.CfnDistribution.CustomOriginConfigProperty(
            origin_protocol_policy="originProtocolPolicy",

            # the properties below are optional
            http_port=123,
            https_port=123,
            origin_keepalive_timeout=123,
            origin_read_timeout=123,
            origin_ssl_protocols=["originSslProtocols"]
        ),
        origin_custom_headers=[cloudfront.CfnDistribution.OriginCustomHeaderProperty(
            header_name="headerName",
            header_value="headerValue"
        )],
        origin_path="originPath",
        origin_shield=cloudfront.CfnDistribution.OriginShieldProperty(
            enabled=False,
            origin_shield_region="originShieldRegion"
        ),
        s3_origin_config=cloudfront.CfnDistribution.S3OriginConfigProperty(
            origin_access_identity="originAccessIdentity"
        )
    )
)

Attributes

failover_config

The failover configuration for this Origin.

Default
  • nothing is returned

Return type

Optional[OriginFailoverConfig]

origin_property

The CloudFormation OriginProperty configuration for this Origin.

Default
  • nothing is returned

Return type

Optional[OriginProperty]