@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)
74 lines (73 loc) • 4.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A real-time log configuration.
*/
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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, 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 Amazon Resource Name (ARN) of the real-time log configuration. For example: `arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig` .
*/
readonly arn: pulumi.Output<string>;
/**
* Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
*/
readonly endPoints: pulumi.Output<outputs.cloudfront.RealtimeLogConfigEndPoint[]>;
/**
* A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
* For more information about fields, see [Real-time log configuration fields](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) in the *Amazon CloudFront Developer Guide*.
*/
readonly fields: pulumi.Output<string[]>;
/**
* The unique name of 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. The sampling rate is 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);
}
/**
* The set of arguments for constructing a RealtimeLogConfig resource.
*/
export interface RealtimeLogConfigArgs {
/**
* Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
*/
endPoints: pulumi.Input<pulumi.Input<inputs.cloudfront.RealtimeLogConfigEndPointArgs>[]>;
/**
* A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
* For more information about fields, see [Real-time log configuration fields](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) in the *Amazon CloudFront Developer Guide*.
*/
fields: pulumi.Input<pulumi.Input<string>[]>;
/**
* The unique name of 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. The sampling rate is an integer between 1 and 100, inclusive.
*/
samplingRate: pulumi.Input<number>;
}