@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
143 lines (142 loc) • 5.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provider to manage [Sumologic Data Forwarding Destination](https://help.sumologic.com/docs/manage/data-forwarding/amazon-s3-bucket/#configure-an-s3-data-forwarding-destination)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const exampleDataForwardingDestination = new sumologic.DataForwardingDestination("example_data_forwarding_destination", {
* destinationName: "df-destination",
* description: "some description",
* bucketName: "df-bucket",
* s3Region: "us-east-1",
* authentication: {
* type: "RoleBased",
* roleArn: "arn:aws:iam::your_arn",
* },
* s3ServerSideEncryption: false,
* enabled: true,
* });
* ```
*/
export declare class DataForwardingDestination extends pulumi.CustomResource {
/**
* Get an existing DataForwardingDestination 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?: DataForwardingDestinationState, opts?: pulumi.CustomResourceOptions): DataForwardingDestination;
/**
* Returns true if the given object is an instance of DataForwardingDestination. 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 DataForwardingDestination;
readonly authentication: pulumi.Output<outputs.DataForwardingDestinationAuthentication>;
/**
* The name of the Amazon S3 bucket.
*/
readonly bucketName: pulumi.Output<string>;
/**
* Description of the S3 data forwarding destination.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Name of the S3 data forwarding destination.
*/
readonly destinationName: pulumi.Output<string>;
/**
* True when the data forwarding destination is enabled. Will be treated as _false_ if left blank.
*
* The following attributes are exported:
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* The region where the S3 bucket is located.
*/
readonly s3Region: pulumi.Output<string | undefined>;
/**
* Enable S3 server-side encryption.
*/
readonly s3ServerSideEncryption: pulumi.Output<boolean | undefined>;
/**
* Create a DataForwardingDestination 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: DataForwardingDestinationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DataForwardingDestination resources.
*/
export interface DataForwardingDestinationState {
authentication?: pulumi.Input<inputs.DataForwardingDestinationAuthentication>;
/**
* The name of the Amazon S3 bucket.
*/
bucketName?: pulumi.Input<string>;
/**
* Description of the S3 data forwarding destination.
*/
description?: pulumi.Input<string>;
/**
* Name of the S3 data forwarding destination.
*/
destinationName?: pulumi.Input<string>;
/**
* True when the data forwarding destination is enabled. Will be treated as _false_ if left blank.
*
* The following attributes are exported:
*/
enabled?: pulumi.Input<boolean>;
/**
* The region where the S3 bucket is located.
*/
s3Region?: pulumi.Input<string>;
/**
* Enable S3 server-side encryption.
*/
s3ServerSideEncryption?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a DataForwardingDestination resource.
*/
export interface DataForwardingDestinationArgs {
authentication: pulumi.Input<inputs.DataForwardingDestinationAuthentication>;
/**
* The name of the Amazon S3 bucket.
*/
bucketName: pulumi.Input<string>;
/**
* Description of the S3 data forwarding destination.
*/
description?: pulumi.Input<string>;
/**
* Name of the S3 data forwarding destination.
*/
destinationName: pulumi.Input<string>;
/**
* True when the data forwarding destination is enabled. Will be treated as _false_ if left blank.
*
* The following attributes are exported:
*/
enabled?: pulumi.Input<boolean>;
/**
* The region where the S3 bucket is located.
*/
s3Region?: pulumi.Input<string>;
/**
* Enable S3 server-side encryption.
*/
s3ServerSideEncryption?: pulumi.Input<boolean>;
}