Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.181.1

class VpcOrigin

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.Origins.VpcOrigin
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfrontorigins#VpcOrigin
Javasoftware.amazon.awscdk.services.cloudfront.origins.VpcOrigin
Pythonaws_cdk.aws_cloudfront_origins.VpcOrigin
TypeScript (source)aws-cdk-lib » aws_cloudfront_origins » VpcOrigin

Implements IOrigin

Extends OriginBase

Represents a distribution's VPC origin.

Example

// Creates a distribution from a Network Load Balancer
declare const vpc: ec2.Vpc;
// Create a network load balancer in a VPC. 'internetFacing' can be 'false'.
const nlb = new elbv2.NetworkLoadBalancer(this, 'NLB', {
  vpc,
  internetFacing: false,
  vpcSubnets: { subnetType: ec2.SubnetType.PRIVATE_ISOLATED },
  securityGroups: [new ec2.SecurityGroup(this, 'NLB-SG', { vpc })],
});
new cloudfront.Distribution(this, 'myDist', {
  defaultBehavior: { origin: origins.VpcOrigin.withNetworkLoadBalancer(nlb) },
});

Initializer (protected)

super(domainName: string, props: VpcOriginProps)

Parameters

Properties

NameTypeDescription
propsVpcOriginProps
vpcOrigin?IVpcOrigin

props

Type: VpcOriginProps

vpcOrigin?

Type: IVpcOrigin (optional)

Methods

NameDescription
bind(scope, options)Binds the origin to the associated Distribution.
protected renderVpcOriginConfig()
static withApplicationLoadBalancer(alb, props?)Create a VPC origin with an Application Load Balancer.
static withEc2Instance(instance, props?)Create a VPC origin with an EC2 instance.
static withNetworkLoadBalancer(nlb, props?)Create a VPC origin with a Network Load Balancer.
static withVpcOrigin(origin, props?)Create a VPC origin with an existing VPC origin resource.

bind(scope, options)

public bind(scope: Construct, options: OriginBindOptions): OriginBindConfig

Parameters

Returns

Binds the origin to the associated Distribution.

Can be used to grant permissions, create dependent resources, etc.

protected renderVpcOriginConfig()

protected renderVpcOriginConfig(): VpcOriginConfigProperty

Returns

static withApplicationLoadBalancer(alb, props?)

public static withApplicationLoadBalancer(alb: IApplicationLoadBalancer, props?: VpcOriginWithEndpointProps): VpcOrigin

Parameters

Returns

Create a VPC origin with an Application Load Balancer.

static withEc2Instance(instance, props?)

public static withEc2Instance(instance: IInstance, props?: VpcOriginWithEndpointProps): VpcOrigin

Parameters

Returns

Create a VPC origin with an EC2 instance.

static withNetworkLoadBalancer(nlb, props?)

public static withNetworkLoadBalancer(nlb: INetworkLoadBalancer, props?: VpcOriginWithEndpointProps): VpcOrigin

Parameters

Returns

Create a VPC origin with a Network Load Balancer.

static withVpcOrigin(origin, props?)

public static withVpcOrigin(origin: IVpcOrigin, props?: VpcOriginProps): VpcOrigin

Parameters

Returns

Create a VPC origin with an existing VPC origin resource.

← PreviousNext →