@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
244 lines (243 loc) • 9.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages an AWS CloudFront Connection Function.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.cloudfront.ConnectionFunction("example", {
* name: "example-connection-function",
* connectionFunctionCode: "function handler(event) { return event.request; }",
* connectionFunctionConfig: {
* runtime: "cloudfront-js-2.0",
* comment: "Example connection function",
* },
* });
* ```
*
* ### With Publish Enabled
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.cloudfront.ConnectionFunction("example", {
* name: "example-connection-function",
* connectionFunctionCode: "function handler(event) { return event.request; }",
* connectionFunctionConfig: {
* runtime: "cloudfront-js-2.0",
* comment: "Example connection function",
* },
* publish: true,
* });
* ```
*
* ### With Key Value Store Associations
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.cloudfront.KeyValueStore("example", {
* name: "example-kvs",
* comment: "Example key value store",
* });
* const exampleConnectionFunction = new aws.cloudfront.ConnectionFunction("example", {
* name: "example-connection-function",
* connectionFunctionCode: "function handler(event) { return event.request; }",
* connectionFunctionConfig: {
* runtime: "cloudfront-js-2.0",
* comment: "Example connection function",
* keyValueStoreAssociation: {
* keyValueStoreArn: example.arn,
* },
* },
* });
* ```
*
* ### With Tags
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.cloudfront.ConnectionFunction("example", {
* name: "example-connection-function",
* connectionFunctionCode: "function handler(event) { return event.request; }",
* connectionFunctionConfig: {
* runtime: "cloudfront-js-2.0",
* comment: "Example connection function",
* },
* tags: {
* Environment: "production",
* Team: "web",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import CloudFront Connection Function using the function ID. For example:
*
* ```sh
* $ pulumi import aws:cloudfront/connectionFunction:ConnectionFunction example E1PA6795UKMFR9
* ```
*/
export declare class ConnectionFunction extends pulumi.CustomResource {
/**
* Get an existing ConnectionFunction 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?: ConnectionFunctionState, opts?: pulumi.CustomResourceOptions): ConnectionFunction;
/**
* Returns true if the given object is an instance of ConnectionFunction. 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 ConnectionFunction;
/**
* ARN of the connection function.
*/
readonly connectionFunctionArn: pulumi.Output<string>;
/**
* Code for the connection function. Maximum length is 40960 characters.
*/
readonly connectionFunctionCode: pulumi.Output<string>;
/**
* Configuration information for the connection function. See `connectionFunctionConfig` below.
*/
readonly connectionFunctionConfig: pulumi.Output<outputs.cloudfront.ConnectionFunctionConnectionFunctionConfig | undefined>;
/**
* ETag of the connection function.
*/
readonly etag: pulumi.Output<string>;
/**
* ETag of the function's LIVE stage. Will be empty if the function has not been published.
*/
readonly liveStageEtag: pulumi.Output<string>;
/**
* Name for the connection function. Must be 1-64 characters and can contain letters, numbers, hyphens, and underscores. Changing this forces a new resource to be created.
*
* The following arguments are optional:
*/
readonly name: pulumi.Output<string>;
/**
* Whether to publish the function to the `LIVE` stage after creation or update. Defaults to `false`.
*/
readonly publish: pulumi.Output<boolean>;
/**
* Status of the connection function.
*/
readonly status: pulumi.Output<string>;
/**
* Map of tags to assign to the resource. 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>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a ConnectionFunction 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: ConnectionFunctionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ConnectionFunction resources.
*/
export interface ConnectionFunctionState {
/**
* ARN of the connection function.
*/
connectionFunctionArn?: pulumi.Input<string>;
/**
* Code for the connection function. Maximum length is 40960 characters.
*/
connectionFunctionCode?: pulumi.Input<string>;
/**
* Configuration information for the connection function. See `connectionFunctionConfig` below.
*/
connectionFunctionConfig?: pulumi.Input<inputs.cloudfront.ConnectionFunctionConnectionFunctionConfig>;
/**
* ETag of the connection function.
*/
etag?: pulumi.Input<string>;
/**
* ETag of the function's LIVE stage. Will be empty if the function has not been published.
*/
liveStageEtag?: pulumi.Input<string>;
/**
* Name for the connection function. Must be 1-64 characters and can contain letters, numbers, hyphens, and underscores. Changing this forces a new resource to be created.
*
* The following arguments are optional:
*/
name?: pulumi.Input<string>;
/**
* Whether to publish the function to the `LIVE` stage after creation or update. Defaults to `false`.
*/
publish?: pulumi.Input<boolean>;
/**
* Status of the connection function.
*/
status?: pulumi.Input<string>;
/**
* Map of tags to assign to the resource. 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>;
}>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a ConnectionFunction resource.
*/
export interface ConnectionFunctionArgs {
/**
* Code for the connection function. Maximum length is 40960 characters.
*/
connectionFunctionCode: pulumi.Input<string>;
/**
* Configuration information for the connection function. See `connectionFunctionConfig` below.
*/
connectionFunctionConfig?: pulumi.Input<inputs.cloudfront.ConnectionFunctionConnectionFunctionConfig>;
/**
* Name for the connection function. Must be 1-64 characters and can contain letters, numbers, hyphens, and underscores. Changing this forces a new resource to be created.
*
* The following arguments are optional:
*/
name?: pulumi.Input<string>;
/**
* Whether to publish the function to the `LIVE` stage after creation or update. Defaults to `false`.
*/
publish?: pulumi.Input<boolean>;
/**
* Map of tags to assign to the resource. 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>;
}>;
}