Package software.amazon.awscdk.services.memorydb

Class CfnSubnetGroup

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.memorydb.CfnSubnetGroup
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:00.371Z") @Stability(Stable) public class CfnSubnetGroup extends CfnResource implements IInspectable
A CloudFormation AWS::MemoryDB::SubnetGroup.

Specifies a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your cluster s running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC , you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups .

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.memorydb.*;
 CfnSubnetGroup cfnSubnetGroup = CfnSubnetGroup.Builder.create(this, "MyCfnSubnetGroup")
         .subnetGroupName("subnetGroupName")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .description("description")
         .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

    • CfnSubnetGroup

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

    • CfnSubnetGroup

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

    • CfnSubnetGroup

      @Stability(Stable) public CfnSubnetGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnSubnetGroupProps props)
      Create a new AWS::MemoryDB::SubnetGroup.

      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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the subnet group, such as arn:aws:memorydb:us-east-1:123456789012:subnetgroup/my-subnet-group.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getSubnetGroupName

      @Stability(Stable) @NotNull public String getSubnetGroupName()
      The name of the subnet group to be used for the cluster .

    • setSubnetGroupName

      @Stability(Stable) public void setSubnetGroupName(@NotNull String value)
      The name of the subnet group to be used for the cluster .

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      A list of Amazon VPC subnet IDs for the subnet group.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      A list of Amazon VPC subnet IDs for the subnet group.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the subnet group.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the subnet group.