Package software.amazon.awscdk.services.docdb

Interface CfnDBSubnetGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBSubnetGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:17.212Z")
@Stability(Stable)
public interface CfnDBSubnetGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDBSubnetGroup.

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.docdb.*;
 CfnDBSubnetGroupProps cfnDBSubnetGroupProps = CfnDBSubnetGroupProps.builder()
         .dbSubnetGroupDescription("dbSubnetGroupDescription")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .dbSubnetGroupName("dbSubnetGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDBSubnetGroupProps.Builder	builder()
String	getDbSubnetGroupDescription()	The description for the subnet group.
default String	getDbSubnetGroupName()	The name for the subnet group.
List<String>	getSubnetIds()	The Amazon EC2 subnet IDs for the subnet group.
default List<CfnTag>	getTags()	The tags to be assigned to the subnet group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDbSubnetGroupDescription

@Stability(Stable)
@NotNull
String getDbSubnetGroupDescription()

The description for the subnet group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupdescription

getSubnetIds

@Stability(Stable)
@NotNull
List<String> getSubnetIds()

The Amazon EC2 subnet IDs for the subnet group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-subnetids

getDbSubnetGroupName

@Stability(Stable)
@Nullable
default String getDbSubnetGroupName()

The name for the subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupname

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to be assigned to the subnet group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-tags

builder

@Stability(Stable)
static CfnDBSubnetGroupProps.Builder builder()

Returns:

a CfnDBSubnetGroupProps.Builder of CfnDBSubnetGroupProps