@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
169 lines (168 loc) • 6.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = new aws.ec2.Vpc("foo", {cidrBlock: "10.1.0.0/16"});
* const fooSubnet = new aws.ec2.Subnet("foo", {
* cidrBlock: "10.1.1.0/24",
* availabilityZone: "us-west-2a",
* vpcId: foo.id,
* tags: {
* Name: "tf-dbsubnet-test-1",
* },
* });
* const bar = new aws.ec2.Subnet("bar", {
* cidrBlock: "10.1.2.0/24",
* availabilityZone: "us-west-2b",
* vpcId: foo.id,
* tags: {
* Name: "tf-dbsubnet-test-2",
* },
* });
* const fooSubnetGroup = new aws.redshift.SubnetGroup("foo", {
* name: "foo",
* subnetIds: [
* fooSubnet.id,
* bar.id,
* ],
* tags: {
* environment: "Production",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Redshift subnet groups using the `name`. For example:
*
* ```sh
* $ pulumi import aws:redshift/subnetGroup:SubnetGroup testgroup1 test-cluster-subnet-group
* ```
*/
export declare class SubnetGroup extends pulumi.CustomResource {
/**
* Get an existing SubnetGroup 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?: SubnetGroupState, opts?: pulumi.CustomResourceOptions): SubnetGroup;
/**
* Returns true if the given object is an instance of SubnetGroup. 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 SubnetGroup;
/**
* Amazon Resource Name (ARN) of the Redshift Subnet group name
*/
readonly arn: pulumi.Output<string>;
/**
* The description of the Redshift Subnet group. Defaults to "Managed by Pulumi".
*/
readonly description: pulumi.Output<string>;
/**
* The name of the Redshift Subnet group.
*/
readonly name: 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>;
/**
* An array of VPC subnet IDs.
*/
readonly subnetIds: 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;
}>;
/**
* Create a SubnetGroup 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: SubnetGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SubnetGroup resources.
*/
export interface SubnetGroupState {
/**
* Amazon Resource Name (ARN) of the Redshift Subnet group name
*/
arn?: pulumi.Input<string>;
/**
* The description of the Redshift Subnet group. Defaults to "Managed by Pulumi".
*/
description?: pulumi.Input<string>;
/**
* The name of the Redshift Subnet group.
*/
name?: 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>;
/**
* An array of VPC subnet IDs.
*/
subnetIds?: pulumi.Input<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>;
}>;
}
/**
* The set of arguments for constructing a SubnetGroup resource.
*/
export interface SubnetGroupArgs {
/**
* The description of the Redshift Subnet group. Defaults to "Managed by Pulumi".
*/
description?: pulumi.Input<string>;
/**
* The name of the Redshift Subnet group.
*/
name?: 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>;
/**
* An array of VPC subnet IDs.
*/
subnetIds: pulumi.Input<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>;
}>;
}