LoadBalancerV2Origin
- class aws_cdk.aws_cloudfront_origins.LoadBalancerV2Origin(load_balancer, *, http_port=None, https_port=None, keepalive_timeout=None, origin_ssl_protocols=None, protocol_policy=None, read_timeout=None, origin_path=None, connection_attempts=None, connection_timeout=None, custom_headers=None, origin_access_control_id=None, origin_id=None, origin_shield_enabled=None, origin_shield_region=None)
Bases:
HttpOrigin
An Origin for a v2 load balancer.
- ExampleMetadata:
infused
Example:
import aws_cdk.aws_ec2 as ec2 import aws_cdk.aws_elasticloadbalancingv2 as elbv2 # vpc: ec2.Vpc # Create an application load balancer in a VPC. 'internetFacing' must be 'true' # for CloudFront to access the load balancer and use it as an origin. lb = elbv2.ApplicationLoadBalancer(self, "LB", vpc=vpc, internet_facing=True ) cloudfront.Distribution(self, "myDist", default_behavior=cloudfront.BehaviorOptions(origin=origins.LoadBalancerV2Origin(lb)) )
- Parameters:
load_balancer (
ILoadBalancerV2
) –http_port (
Union
[int
,float
,None
]) – The HTTP port that CloudFront uses to connect to the origin. Default: 80https_port (
Union
[int
,float
,None
]) – The HTTPS port that CloudFront uses to connect to the origin. Default: 443keepalive_timeout (
Optional
[Duration
]) – Specifies how long, in seconds, CloudFront persists its connection to the origin. The valid range is from 1 to 180 seconds, inclusive. Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time. Default: Duration.seconds(5)origin_ssl_protocols (
Optional
[Sequence
[OriginSslPolicy
]]) – The SSL versions to use when interacting with the origin. Default: OriginSslPolicy.TLS_V1_2protocol_policy (
Optional
[OriginProtocolPolicy
]) – Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Default: OriginProtocolPolicy.HTTPS_ONLYread_timeout (
Optional
[Duration
]) – Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout. The valid range is from 1 to 180 seconds, inclusive. Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time. Default: Duration.seconds(30)origin_path (
Optional
[str
]) – An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. Must begin, but not end, with ‘/’ (e.g., ‘/production/images’). Default: ‘/’connection_attempts (
Union
[int
,float
,None
]) – The number of times that CloudFront attempts to connect to the origin; valid values are 1, 2, or 3 attempts. Default: 3connection_timeout (
Optional
[Duration
]) – The number of seconds that CloudFront waits when trying to establish a connection to the origin. Valid values are 1-10 seconds, inclusive. Default: Duration.seconds(10)custom_headers (
Optional
[Mapping
[str
,str
]]) – A list of HTTP header names and values that CloudFront adds to requests it sends to the origin. Default: {}origin_access_control_id (
Optional
[str
]) – The unique identifier of an origin access control for this origin. Default: - no origin access controlorigin_id (
Optional
[str
]) – A unique identifier for the origin. This value must be unique within the distribution. Default: - an originid will be generated for youorigin_shield_enabled (
Optional
[bool
]) – Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false. Default: - trueorigin_shield_region (
Optional
[str
]) – When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance. Default: - origin shield not enabled
Methods
- bind(_scope, *, origin_id, distribution_id=None)
Binds the origin to the associated Distribution.
Can be used to grant permissions, create dependent resources, etc.
- Parameters:
_scope (
Construct
) –origin_id (
str
) – The identifier of this Origin, as assigned by the Distribution this Origin has been used added to.distribution_id (
Optional
[str
]) – The identifier of the Distribution this Origin is used for. This is used to grant origin access permissions to the distribution for origin access control. Default: - no distribution id
- Return type: