Package software.amazon.awscdk.services.redshift.alpha

Interface ClusterSubnetGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterSubnetGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:26.086Z")
@Stability(Experimental)
public interface ClusterSubnetGroupProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for creating a ClusterSubnetGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.alpha.*;
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ec2.*;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Vpc vpc;
 ClusterSubnetGroupProps clusterSubnetGroupProps = ClusterSubnetGroupProps.builder()
         .description("description")
         .vpc(vpc)
         // the properties below are optional
         .removalPolicy(RemovalPolicy.DESTROY)
         .vpcSubnets(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ClusterSubnetGroupProps.Builder	A builder for ClusterSubnetGroupProps
static final class	ClusterSubnetGroupProps.Jsii$Proxy	An implementation for ClusterSubnetGroupProps

Method Summary

Modifier and Type	Method	Description
static ClusterSubnetGroupProps.Builder	builder()
String	getDescription()	(experimental) Description of the subnet group.
default RemovalPolicy	getRemovalPolicy()	(experimental) The removal policy to apply when the subnet group are removed from the stack or replaced during an update.
IVpc	getVpc()	(experimental) The VPC to place the subnet group in.
default SubnetSelection	getVpcSubnets()	(experimental) Which subnets within the VPC to associate with this group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Experimental)
@NotNull
String getDescription()

(experimental) Description of the subnet group.

getVpc

@Stability(Experimental)
@NotNull
IVpc getVpc()

(experimental) The VPC to place the subnet group in.

getRemovalPolicy

@Stability(Experimental)
@Nullable
default RemovalPolicy getRemovalPolicy()

(experimental) The removal policy to apply when the subnet group are removed from the stack or replaced during an update.

Default: RemovalPolicy.RETAIN

getVpcSubnets

@Stability(Experimental)
@Nullable
default SubnetSelection getVpcSubnets()

(experimental) Which subnets within the VPC to associate with this group.

Default: - private subnets

builder

@Stability(Experimental)
static ClusterSubnetGroupProps.Builder builder()

Returns:

a ClusterSubnetGroupProps.Builder of ClusterSubnetGroupProps