@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
153 lines (152 loc) • 5.29 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Creates an Amazon CloudFront VPC origin.
*
* For information about CloudFront VPC origins, see
* [Amazon CloudFront Developer Guide - Restrict access with VPC origins][1].
*
* ## Example Usage
*
* ### Application Load Balancer
*
* The following example below creates a CloudFront VPC origin for a Application Load Balancer.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const alb = new aws.cloudfront.VpcOrigin("alb", {vpcOriginEndpointConfig: {
* name: "example-vpc-origin",
* arn: _this.arn,
* httpPort: 8080,
* httpsPort: 8443,
* originProtocolPolicy: "https-only",
* originSslProtocols: {
* items: ["TLSv1.2"],
* quantity: 1,
* },
* }});
* ```
*
* ## Import
*
* terraform
*
* import {
*
* to = aws_cloudfront_vpc_origin.origin
*
* id = "vo_JQEa410sssUFoY6wMkx69j"
*
* }
*
* Using `pulumi import`, import Cloudfront VPC origins using the `id`. For example:
*
* console
*
* % pulumi import aws_cloudfront_vpc_origin vo_JQEa410sssUFoY6wMkx69j
*/
export declare class VpcOrigin extends pulumi.CustomResource {
/**
* Get an existing VpcOrigin resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpcOriginState, opts?: pulumi.CustomResourceOptions): VpcOrigin;
/**
* Returns true if the given object is an instance of VpcOrigin. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VpcOrigin;
/**
* The VPC origin ARN.
*/
readonly arn: pulumi.Output<string>;
/**
* The current version of the origin.
*/
readonly etag: pulumi.Output<string>;
/**
* Key-value tags for the place index. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
readonly timeouts: pulumi.Output<outputs.cloudfront.VpcOriginTimeouts | undefined>;
/**
* The VPC origin endpoint configuration.
*
* The following arguments are optional:
*/
readonly vpcOriginEndpointConfig: pulumi.Output<outputs.cloudfront.VpcOriginVpcOriginEndpointConfig | undefined>;
/**
* Create a VpcOrigin resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: VpcOriginArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpcOrigin resources.
*/
export interface VpcOriginState {
/**
* The VPC origin ARN.
*/
arn?: pulumi.Input<string>;
/**
* The current version of the origin.
*/
etag?: pulumi.Input<string>;
/**
* Key-value tags for the place index. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.cloudfront.VpcOriginTimeouts>;
/**
* The VPC origin endpoint configuration.
*
* The following arguments are optional:
*/
vpcOriginEndpointConfig?: pulumi.Input<inputs.cloudfront.VpcOriginVpcOriginEndpointConfig>;
}
/**
* The set of arguments for constructing a VpcOrigin resource.
*/
export interface VpcOriginArgs {
/**
* Key-value tags for the place index. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.cloudfront.VpcOriginTimeouts>;
/**
* The VPC origin endpoint configuration.
*
* The following arguments are optional:
*/
vpcOriginEndpointConfig?: pulumi.Input<inputs.cloudfront.VpcOriginVpcOriginEndpointConfig>;
}