@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
193 lines (192 loc) • 6.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing a Verified Access Logging Configuration.
*
* ## Example Usage
*
* ### With CloudWatch Logging
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.verifiedaccess.InstanceLoggingConfiguration("example", {
* accessLogs: {
* cloudwatchLogs: {
* enabled: true,
* logGroup: exampleAwsCloudwatchLogGroup.id,
* },
* },
* verifiedaccessInstanceId: exampleAwsVerifiedaccessInstance.id,
* });
* ```
*
* ### With Kinesis Data Firehose Logging
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.verifiedaccess.InstanceLoggingConfiguration("example", {
* accessLogs: {
* kinesisDataFirehose: {
* deliveryStream: exampleAwsKinesisFirehoseDeliveryStream.name,
* enabled: true,
* },
* },
* verifiedaccessInstanceId: exampleAwsVerifiedaccessInstance.id,
* });
* ```
*
* ### With S3 logging
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.verifiedaccess.InstanceLoggingConfiguration("example", {
* accessLogs: {
* s3: {
* bucketName: exampleAwsS3Bucket.id,
* enabled: true,
* prefix: "example",
* },
* },
* verifiedaccessInstanceId: exampleAwsVerifiedaccessInstance.id,
* });
* ```
*
* ### With all three logging options
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.verifiedaccess.InstanceLoggingConfiguration("example", {
* accessLogs: {
* cloudwatchLogs: {
* enabled: true,
* logGroup: exampleAwsCloudwatchLogGroup.id,
* },
* kinesisDataFirehose: {
* deliveryStream: exampleAwsKinesisFirehoseDeliveryStream.name,
* enabled: true,
* },
* s3: {
* bucketName: exampleAwsS3Bucket.id,
* enabled: true,
* },
* },
* verifiedaccessInstanceId: exampleAwsVerifiedaccessInstance.id,
* });
* ```
*
* ### With `includeTrustContext`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.verifiedaccess.InstanceLoggingConfiguration("example", {
* accessLogs: {
* includeTrustContext: true,
* },
* verifiedaccessInstanceId: exampleAwsVerifiedaccessInstance.id,
* });
* ```
*
* ### With `logVersion`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.verifiedaccess.InstanceLoggingConfiguration("example", {
* accessLogs: {
* logVersion: "ocsf-1.0.0-rc.2",
* },
* verifiedaccessInstanceId: exampleAwsVerifiedaccessInstance.id,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Verified Access Logging Configuration using the Verified Access Instance `id`. For example:
*
* ```sh
* $ pulumi import aws:verifiedaccess/instanceLoggingConfiguration:InstanceLoggingConfiguration example vai-1234567890abcdef0
* ```
*/
export declare class InstanceLoggingConfiguration extends pulumi.CustomResource {
/**
* Get an existing InstanceLoggingConfiguration 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?: InstanceLoggingConfigurationState, opts?: pulumi.CustomResourceOptions): InstanceLoggingConfiguration;
/**
* Returns true if the given object is an instance of InstanceLoggingConfiguration. 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 InstanceLoggingConfiguration;
/**
* A block that specifies the configuration options for Verified Access instances. Detailed below.
*/
readonly accessLogs: pulumi.Output<outputs.verifiedaccess.InstanceLoggingConfigurationAccessLogs>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* The ID of the Verified Access instance.
*/
readonly verifiedaccessInstanceId: pulumi.Output<string>;
/**
* Create a InstanceLoggingConfiguration 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: InstanceLoggingConfigurationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InstanceLoggingConfiguration resources.
*/
export interface InstanceLoggingConfigurationState {
/**
* A block that specifies the configuration options for Verified Access instances. Detailed below.
*/
accessLogs?: pulumi.Input<inputs.verifiedaccess.InstanceLoggingConfigurationAccessLogs>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The ID of the Verified Access instance.
*/
verifiedaccessInstanceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a InstanceLoggingConfiguration resource.
*/
export interface InstanceLoggingConfigurationArgs {
/**
* A block that specifies the configuration options for Verified Access instances. Detailed below.
*/
accessLogs: pulumi.Input<inputs.verifiedaccess.InstanceLoggingConfigurationAccessLogs>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The ID of the Verified Access instance.
*/
verifiedaccessInstanceId: pulumi.Input<string>;
}