@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
162 lines (161 loc) • 6.67 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a CloudFront real-time log configuration resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const assumeRole = aws.iam.getPolicyDocument({
* statements: [{
* effect: "Allow",
* principals: [{
* type: "Service",
* identifiers: ["cloudfront.amazonaws.com"],
* }],
* actions: ["sts:AssumeRole"],
* }],
* });
* const exampleRole = new aws.iam.Role("example", {
* name: "cloudfront-realtime-log-config-example",
* assumeRolePolicy: assumeRole.then(assumeRole => assumeRole.json),
* });
* const example = aws.iam.getPolicyDocument({
* statements: [{
* effect: "Allow",
* actions: [
* "kinesis:DescribeStreamSummary",
* "kinesis:DescribeStream",
* "kinesis:PutRecord",
* "kinesis:PutRecords",
* ],
* resources: [exampleAwsKinesisStream.arn],
* }],
* });
* const exampleRolePolicy = new aws.iam.RolePolicy("example", {
* name: "cloudfront-realtime-log-config-example",
* role: exampleRole.id,
* policy: example.then(example => example.json),
* });
* const exampleRealtimeLogConfig = new aws.cloudfront.RealtimeLogConfig("example", {
* name: "example",
* samplingRate: 75,
* fields: [
* "timestamp",
* "c-ip",
* ],
* endpoint: {
* streamType: "Kinesis",
* kinesisStreamConfig: {
* roleArn: exampleRole.arn,
* streamArn: exampleAwsKinesisStream.arn,
* },
* },
* }, {
* dependsOn: [exampleRolePolicy],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import CloudFront real-time log configurations using the ARN. For example:
*
* ```sh
* $ pulumi import aws:cloudfront/realtimeLogConfig:RealtimeLogConfig example arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig
* ```
*/
export declare class RealtimeLogConfig extends pulumi.CustomResource {
/**
* Get an existing RealtimeLogConfig 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?: RealtimeLogConfigState, opts?: pulumi.CustomResourceOptions): RealtimeLogConfig;
/**
* Returns true if the given object is an instance of RealtimeLogConfig. 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 RealtimeLogConfig;
/**
* The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
*/
readonly arn: pulumi.Output<string>;
/**
* The Amazon Kinesis data streams where real-time log data is sent.
*/
readonly endpoint: pulumi.Output<outputs.cloudfront.RealtimeLogConfigEndpoint>;
/**
* The fields that are included in each real-time log record. See the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) for supported values.
*/
readonly fields: pulumi.Output<string[]>;
/**
* The unique name to identify this real-time log configuration.
*/
readonly name: pulumi.Output<string>;
/**
* The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. An integer between `1` and `100`, inclusive.
*/
readonly samplingRate: pulumi.Output<number>;
/**
* Create a RealtimeLogConfig 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: RealtimeLogConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RealtimeLogConfig resources.
*/
export interface RealtimeLogConfigState {
/**
* The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
*/
arn?: pulumi.Input<string>;
/**
* The Amazon Kinesis data streams where real-time log data is sent.
*/
endpoint?: pulumi.Input<inputs.cloudfront.RealtimeLogConfigEndpoint>;
/**
* The fields that are included in each real-time log record. See the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) for supported values.
*/
fields?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The unique name to identify this real-time log configuration.
*/
name?: pulumi.Input<string>;
/**
* The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. An integer between `1` and `100`, inclusive.
*/
samplingRate?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a RealtimeLogConfig resource.
*/
export interface RealtimeLogConfigArgs {
/**
* The Amazon Kinesis data streams where real-time log data is sent.
*/
endpoint: pulumi.Input<inputs.cloudfront.RealtimeLogConfigEndpoint>;
/**
* The fields that are included in each real-time log record. See the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) for supported values.
*/
fields: pulumi.Input<pulumi.Input<string>[]>;
/**
* The unique name to identify this real-time log configuration.
*/
name?: pulumi.Input<string>;
/**
* The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. An integer between `1` and `100`, inclusive.
*/
samplingRate: pulumi.Input<number>;
}