ClusterSubnetGroup
- class aws_cdk.aws_redshift.ClusterSubnetGroup(scope, id, *, description, vpc, removal_policy=None, vpc_subnets=None)
Bases:
Resource
(experimental) Class for creating a Redshift cluster subnet group.
- Stability:
experimental
- Resource:
AWS::Redshift::ClusterSubnetGroup
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 import aws_cdk.aws_redshift as redshift import aws_cdk.core as cdk # subnet: ec2.Subnet # subnet_filter: ec2.SubnetFilter # vpc: ec2.Vpc cluster_subnet_group = redshift.ClusterSubnetGroup(self, "MyClusterSubnetGroup", description="description", vpc=vpc, # the properties below are optional removal_policy=cdk.RemovalPolicy.DESTROY, vpc_subnets=ec2.SubnetSelection( availability_zones=["availabilityZones"], one_per_az=False, subnet_filters=[subnet_filter], subnet_group_name="subnetGroupName", subnet_name="subnetName", subnets=[subnet], subnet_type=ec2.SubnetType.ISOLATED ) )
- Parameters:
scope (
Construct
)id (
str
)description (
str
) – (experimental) Description of the subnet group.vpc (
IVpc
) – (experimental) The VPC to place the subnet group in.removal_policy (
Optional
[RemovalPolicy
]) – (experimental) The removal policy to apply when the subnet group are removed from the stack or replaced during an update. Default: RemovalPolicy.RETAINvpc_subnets (
Union
[SubnetSelection
,Dict
[str
,Any
],None
]) – (experimental) Which subnets within the VPC to associate with this group. Default: - private subnets
- Stability:
experimental
Methods
- apply_removal_policy(policy)
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
RemovalPolicy
)- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- cluster_subnet_group_name
(experimental) The name of the cluster subnet group.
- Stability:
experimental
- env
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- node
The construct tree node associated with this construct.
- stack
The stack in which this resource is defined.
Static Methods
- classmethod from_cluster_subnet_group_name(scope, id, cluster_subnet_group_name)
(experimental) Imports an existing subnet group by name.
- Parameters:
scope (
Construct
)id (
str
)cluster_subnet_group_name (
str
)
- Stability:
experimental
- Return type:
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
)- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
)- Return type:
bool