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 (construct)

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

Implements IConstruct, IDependable, IResource, IVpcOrigin, ITaggableV2

A CloudFront VPC Origin configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';

declare const vpcOriginEndpoint: cloudfront.VpcOriginEndpoint;
const vpcOrigin = new cloudfront.VpcOrigin(this, 'MyVpcOrigin', {
  endpoint: vpcOriginEndpoint,

  // the properties below are optional
  httpPort: 123,
  httpsPort: 123,
  originSslProtocols: [cloudfront.OriginSslPolicy.SSL_V3],
  protocolPolicy: cloudfront.OriginProtocolPolicy.HTTP_ONLY,
  vpcOriginName: 'vpcOriginName',
});

Initializer

new VpcOrigin(scope: Construct, id: string, props: VpcOriginProps)

Parameters

Construct Props

NameTypeDescription
endpointVpcOriginEndpointThe VPC origin endpoint.
httpPort?numberThe HTTP port for the CloudFront VPC origin endpoint configuration.
httpsPort?numberThe HTTPS port of the CloudFront VPC origin endpoint configuration.
originSslProtocols?OriginSslPolicy[]A list that contains allowed SSL/TLS protocols for this distribution.
protocolPolicy?OriginProtocolPolicyThe origin protocol policy for the CloudFront VPC origin endpoint configuration.
vpcOriginName?stringThe name of the CloudFront VPC origin endpoint configuration.

endpoint

Type: VpcOriginEndpoint

The VPC origin endpoint.

httpPort?

Type: number (optional, default: 80)

The HTTP port for the CloudFront VPC origin endpoint configuration.

httpsPort?

Type: number (optional, default: 443)

The HTTPS port of the CloudFront VPC origin endpoint configuration.

originSslProtocols?

Type: OriginSslPolicy[] (optional, default: TLSv1.2)

A list that contains allowed SSL/TLS protocols for this distribution.

protocolPolicy?

Type: OriginProtocolPolicy (optional, default: OriginProtocolPolicy.MATCH_VIEWER)

The origin protocol policy for the CloudFront VPC origin endpoint configuration.

vpcOriginName?

Type: string (optional, default: generated from the id)

The name of the CloudFront VPC origin endpoint configuration.

Properties

NameTypeDescription
cdkTagManagerTagManagerTagManager to set, remove and format tags.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
vpcOriginArnstringThe VPC origin ARN.
vpcOriginIdstringThe VPC origin ID.
domainName?stringThe domain name of the CloudFront VPC origin endpoint configuration.

cdkTagManager

Type: TagManager

TagManager to set, remove and format tags.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

Type: Node

The tree node.

stack

Type: Stack

The stack in which this resource is defined.

vpcOriginArn

Type: string

The VPC origin ARN.

vpcOriginId

Type: string

The VPC origin ID.

domainName?

Type: string (optional)

The domain name of the CloudFront VPC origin endpoint configuration.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
static fromVpcOriginArn(scope, id, vpcOriginArn)Import an existing VPC origin from its ARN.
static fromVpcOriginAttributes(scope, id, attrs)Import an existing VPC origin from its attributes.
static fromVpcOriginId(scope, id, vpcOriginId)Import an existing VPC origin from its ID.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

static fromVpcOriginArn(scope, id, vpcOriginArn)

public static fromVpcOriginArn(scope: Construct, id: string, vpcOriginArn: string): IVpcOrigin

Parameters

  • scope Construct
  • id string
  • vpcOriginArn string

Returns

Import an existing VPC origin from its ARN.

static fromVpcOriginAttributes(scope, id, attrs)

public static fromVpcOriginAttributes(scope: Construct, id: string, attrs: VpcOriginAttributes): IVpcOrigin

Parameters

Returns

Import an existing VPC origin from its attributes.

static fromVpcOriginId(scope, id, vpcOriginId)

public static fromVpcOriginId(scope: Construct, id: string, vpcOriginId: string): IVpcOrigin

Parameters

  • scope Construct
  • id string
  • vpcOriginId string

Returns

Import an existing VPC origin from its ID.

← PreviousNext →