@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
72 lines (71 loc) • 4.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Creates a CF function.
* To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage.
* By default, when you create a function, it’s in the ``DEVELOPMENT`` stage. In this stage, you can [test the function](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/test-function.html) in the CF console (or with ``TestFunction`` in the CF API).
* When you’re ready to use your function with a CF distribution, publish the function to the ``LIVE`` stage. You can do this in the CF console, with ``PublishFunction`` in the CF API, or by updating the ``AWS::CloudFront::Function`` resource with the ``AutoPublish`` property set to ``true``. When the function is published to the ``LIVE`` stage, you can attach it to a distribution’s cache behavior, using the function’s ARN.
* To automatically publish the function to the ``LIVE`` stage when it’s created, set the ``AutoPublish`` property to ``true``.
*/
export declare function getFunction(args: GetFunctionArgs, opts?: pulumi.InvokeOptions): Promise<GetFunctionResult>;
export interface GetFunctionArgs {
/**
* The ARN of the function. For example:
*
* `arn:aws:cloudfront::123456789012:function/ExampleFunction` .
*
* To get the function ARN, use the following syntax:
*
* `!GetAtt *Function_Logical_ID* .FunctionMetadata.FunctionARN`
*/
functionArn: string;
}
export interface GetFunctionResult {
/**
* The ARN of the function. For example:
*
* `arn:aws:cloudfront::123456789012:function/ExampleFunction` .
*
* To get the function ARN, use the following syntax:
*
* `!GetAtt *Function_Logical_ID* .FunctionMetadata.FunctionARN`
*/
readonly functionArn?: string;
/**
* The function code. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) in the *Amazon CloudFront Developer Guide*.
*/
readonly functionCode?: string;
/**
* Contains configuration information about a CloudFront function.
*/
readonly functionConfig?: outputs.cloudfront.FunctionConfig;
/**
* Contains metadata about a CloudFront function.
*/
readonly functionMetadata?: outputs.cloudfront.FunctionMetadata;
/**
* A name to identify the function.
*/
readonly name?: string;
readonly stage?: string;
}
/**
* Creates a CF function.
* To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage.
* By default, when you create a function, it’s in the ``DEVELOPMENT`` stage. In this stage, you can [test the function](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/test-function.html) in the CF console (or with ``TestFunction`` in the CF API).
* When you’re ready to use your function with a CF distribution, publish the function to the ``LIVE`` stage. You can do this in the CF console, with ``PublishFunction`` in the CF API, or by updating the ``AWS::CloudFront::Function`` resource with the ``AutoPublish`` property set to ``true``. When the function is published to the ``LIVE`` stage, you can attach it to a distribution’s cache behavior, using the function’s ARN.
* To automatically publish the function to the ``LIVE`` stage when it’s created, set the ``AutoPublish`` property to ``true``.
*/
export declare function getFunctionOutput(args: GetFunctionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetFunctionResult>;
export interface GetFunctionOutputArgs {
/**
* The ARN of the function. For example:
*
* `arn:aws:cloudfront::123456789012:function/ExampleFunction` .
*
* To get the function ARN, use the following syntax:
*
* `!GetAtt *Function_Logical_ID* .FunctionMetadata.FunctionARN`
*/
functionArn: pulumi.Input<string>;
}