@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
339 lines (338 loc) • 13.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages a VPC Encryption Control.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const exampleVpc = new aws.ec2.Vpc("example", {cidrBlock: "10.1.0.0/16"});
* const example = new aws.ec2.VpcEncryptionControl("example", {
* vpcId: exampleVpc.id,
* mode: "monitor",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import VPC Encryption Control using the `id`. For example:
*
* ```sh
* $ pulumi import aws:ec2/vpcEncryptionControl:VpcEncryptionControl example vpcec-12345678901234567
* ```
*/
export declare class VpcEncryptionControl extends pulumi.CustomResource {
/**
* Get an existing VpcEncryptionControl 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?: VpcEncryptionControlState, opts?: pulumi.CustomResourceOptions): VpcEncryptionControl;
/**
* Returns true if the given object is an instance of VpcEncryptionControl. 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 VpcEncryptionControl;
/**
* Whether to exclude Egress-Only Internet Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
readonly egressOnlyInternetGatewayExclusion: pulumi.Output<string>;
/**
* Whether to exclude Elastic File System (EFS) from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
readonly elasticFileSystemExclusion: pulumi.Output<string>;
/**
* Whether to exclude Internet Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
readonly internetGatewayExclusion: pulumi.Output<string>;
/**
* Whether to exclude Lambda Functions from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
readonly lambdaExclusion: pulumi.Output<string>;
/**
* Mode to enable for VPC Encryption Control.
* Valid values are `monitor` or `enforce`.
*/
readonly mode: pulumi.Output<string>;
/**
* Whether to exclude NAT Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
readonly natGatewayExclusion: pulumi.Output<string>;
/**
* 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>;
/**
* State of exclusions from encryption enforcement.
* Will be `nil` if `mode` is `monitor`.
* See `resourceExclusions` below
*/
readonly resourceExclusions: pulumi.Output<outputs.ec2.VpcEncryptionControlResourceExclusions>;
/**
* The current state of the VPC Encryption Control.
*/
readonly state: pulumi.Output<string>;
/**
* A message providing additional information about the state of the VPC Encryption Control.
*/
readonly stateMessage: pulumi.Output<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
readonly timeouts: pulumi.Output<outputs.ec2.VpcEncryptionControlTimeouts | undefined>;
/**
* Whether to exclude Virtual Private Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
readonly virtualPrivateGatewayExclusion: pulumi.Output<string>;
/**
* The ID of the VPC the VPC Encryption Control is linked to.
*
* The following arguments are optional:
*/
readonly vpcId: pulumi.Output<string>;
/**
* Whether to exclude VPC Lattice from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
readonly vpcLatticeExclusion: pulumi.Output<string>;
/**
* Whether to exclude peered VPCs from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
readonly vpcPeeringExclusion: pulumi.Output<string>;
/**
* Create a VpcEncryptionControl 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: VpcEncryptionControlArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpcEncryptionControl resources.
*/
export interface VpcEncryptionControlState {
/**
* Whether to exclude Egress-Only Internet Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
egressOnlyInternetGatewayExclusion?: pulumi.Input<string>;
/**
* Whether to exclude Elastic File System (EFS) from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
elasticFileSystemExclusion?: pulumi.Input<string>;
/**
* Whether to exclude Internet Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
internetGatewayExclusion?: pulumi.Input<string>;
/**
* Whether to exclude Lambda Functions from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
lambdaExclusion?: pulumi.Input<string>;
/**
* Mode to enable for VPC Encryption Control.
* Valid values are `monitor` or `enforce`.
*/
mode?: pulumi.Input<string>;
/**
* Whether to exclude NAT Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
natGatewayExclusion?: pulumi.Input<string>;
/**
* 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>;
/**
* State of exclusions from encryption enforcement.
* Will be `nil` if `mode` is `monitor`.
* See `resourceExclusions` below
*/
resourceExclusions?: pulumi.Input<inputs.ec2.VpcEncryptionControlResourceExclusions>;
/**
* The current state of the VPC Encryption Control.
*/
state?: pulumi.Input<string>;
/**
* A message providing additional information about the state of the VPC Encryption Control.
*/
stateMessage?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.ec2.VpcEncryptionControlTimeouts>;
/**
* Whether to exclude Virtual Private Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
virtualPrivateGatewayExclusion?: pulumi.Input<string>;
/**
* The ID of the VPC the VPC Encryption Control is linked to.
*
* The following arguments are optional:
*/
vpcId?: pulumi.Input<string>;
/**
* Whether to exclude VPC Lattice from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
vpcLatticeExclusion?: pulumi.Input<string>;
/**
* Whether to exclude peered VPCs from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
vpcPeeringExclusion?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VpcEncryptionControl resource.
*/
export interface VpcEncryptionControlArgs {
/**
* Whether to exclude Egress-Only Internet Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
egressOnlyInternetGatewayExclusion?: pulumi.Input<string>;
/**
* Whether to exclude Elastic File System (EFS) from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
elasticFileSystemExclusion?: pulumi.Input<string>;
/**
* Whether to exclude Internet Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
internetGatewayExclusion?: pulumi.Input<string>;
/**
* Whether to exclude Lambda Functions from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
lambdaExclusion?: pulumi.Input<string>;
/**
* Mode to enable for VPC Encryption Control.
* Valid values are `monitor` or `enforce`.
*/
mode: pulumi.Input<string>;
/**
* Whether to exclude NAT Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
natGatewayExclusion?: pulumi.Input<string>;
/**
* 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>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.ec2.VpcEncryptionControlTimeouts>;
/**
* Whether to exclude Virtual Private Gateways from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
virtualPrivateGatewayExclusion?: pulumi.Input<string>;
/**
* The ID of the VPC the VPC Encryption Control is linked to.
*
* The following arguments are optional:
*/
vpcId: pulumi.Input<string>;
/**
* Whether to exclude VPC Lattice from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
vpcLatticeExclusion?: pulumi.Input<string>;
/**
* Whether to exclude peered VPCs from encryption enforcement.
* Valid values are `disable` or `enable`.
* Default is `disable`.
* Only valid when `mode` is `enforce`.
*/
vpcPeeringExclusion?: pulumi.Input<string>;
}