Package software.amazon.awscdk.services.neptune

Class CfnDBSubnetGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.neptune.CfnDBSubnetGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.322Z") @Stability(Stable) public class CfnDBSubnetGroup extends CfnResource implements IInspectable
A CloudFormation AWS::Neptune::DBSubnetGroup.

The AWS::Neptune::DBSubnetGroup type creates an Amazon Neptune DB subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same AWS Region.

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.neptune.*;
 CfnDBSubnetGroup cfnDBSubnetGroup = CfnDBSubnetGroup.Builder.create(this, "MyCfnDBSubnetGroup")
         .dbSubnetGroupDescription("dbSubnetGroupDescription")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .dbSubnetGroupName("dbSubnetGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDBSubnetGroup

      protected CfnDBSubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDBSubnetGroup

      protected CfnDBSubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDBSubnetGroup

      @Stability(Stable) public CfnDBSubnetGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnDBSubnetGroupProps props)
      Create a new AWS::Neptune::DBSubnetGroup.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags that you want to attach to the DB subnet group.

    • getDbSubnetGroupDescription

      @Stability(Stable) @NotNull public String getDbSubnetGroupDescription()
      Provides the description of the DB subnet group.

    • setDbSubnetGroupDescription

      @Stability(Stable) public void setDbSubnetGroupDescription(@NotNull String value)
      Provides the description of the DB subnet group.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      The Amazon EC2 subnet IDs for the DB subnet group.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      The Amazon EC2 subnet IDs for the DB subnet group.

    • getDbSubnetGroupName

      @Stability(Stable) @Nullable public String getDbSubnetGroupName()
      The name of the DB subnet group.

    • setDbSubnetGroupName

      @Stability(Stable) public void setDbSubnetGroupName(@Nullable String value)
      The name of the DB subnet group.