SubnetGroupProps¶
-
class
aws_cdk.aws_neptune.
SubnetGroupProps
(*, vpc, description=None, removal_policy=None, subnet_group_name=None, vpc_subnets=None)¶ Bases:
object
(experimental) Properties for creating a SubnetGroup.
- Parameters
vpc (
IVpc
) – (experimental) The VPC to place the subnet group in.description (
Optional
[str
]) – (experimental) Description of the subnet group. Default: - a name is generatedremoval_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.DESTROYsubnet_group_name (
Optional
[str
]) – (experimental) The name of the subnet group. Default: - a name is generatedvpc_subnets (
Optional
[SubnetSelection
]) – (experimental) Which subnets within the VPC to associate with this group. Default: - private subnets
- Stability
experimental
- 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_neptune as neptune import aws_cdk.core as cdk # subnet: ec2.Subnet # subnet_filter: ec2.SubnetFilter # vpc: ec2.Vpc subnet_group_props = neptune.SubnetGroupProps( vpc=vpc, # the properties below are optional description="description", removal_policy=cdk.RemovalPolicy.DESTROY, subnet_group_name="subnetGroupName", 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 ) )
Attributes
-
description
¶ (experimental) Description of the subnet group.
- Default
a name is generated
- Stability
experimental
- Return type
Optional
[str
]
-
removal_policy
¶ (experimental) The removal policy to apply when the subnet group are removed from the stack or replaced during an update.
- Default
RemovalPolicy.DESTROY
- Stability
experimental
- Return type
Optional
[RemovalPolicy
]
-
subnet_group_name
¶ (experimental) The name of the subnet group.
- Default
a name is generated
- Stability
experimental
- Return type
Optional
[str
]
-
vpc_subnets
¶ (experimental) Which subnets within the VPC to associate with this group.
- Default
private subnets
- Stability
experimental
- Return type
Optional
[SubnetSelection
]