Package software.amazon.awscdk.services.rds

Class CfnDBShardGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.rds.CfnDBShardGroup
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IDBShardGroupRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:13.236Z") @Stability(Stable) public class CfnDBShardGroup extends CfnResource implements IInspectable, IDBShardGroupRef, ITaggableV2
Creates a new DB shard group for Aurora Limitless Database.

You must enable Aurora Limitless Database to create a DB shard group.

Valid for: Aurora DB clusters only

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.rds.*;
 CfnDBShardGroup cfnDBShardGroup = CfnDBShardGroup.Builder.create(this, "MyCfnDBShardGroup")
         .dbClusterIdentifier("dbClusterIdentifier")
         .maxAcu(123)
         // the properties below are optional
         .computeRedundancy(123)
         .dbShardGroupIdentifier("dbShardGroupIdentifier")
         .minAcu(123)
         .publiclyAccessible(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnDBShardGroup

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

    • CfnDBShardGroup

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

    • CfnDBShardGroup

      @Stability(Stable) public CfnDBShardGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDBShardGroupProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrDbShardGroupResourceId

      @Stability(Stable) @NotNull public String getAttrDbShardGroupResourceId()
      The AWS Region -unique, immutable identifier for the DB shard group.

    • getAttrEndpoint

      @Stability(Stable) @NotNull public String getAttrEndpoint()
      This data type represents the information you need to connect to an Amazon RDS DB instance.

      This data type is used as a response element in the following actions:

      • CreateDBInstance
      • DescribeDBInstances
      • DeleteDBInstance

      For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getDbShardGroupRef

      @Stability(Stable) @NotNull public DBShardGroupReference getDbShardGroupRef()
      A reference to a DBShardGroup resource.
      Specified by:
      getDbShardGroupRef in interface IDBShardGroupRef

    • getDbClusterIdentifier

      @Stability(Stable) @NotNull public String getDbClusterIdentifier()
      The name of the primary DB cluster for the DB shard group.

    • setDbClusterIdentifier

      @Stability(Stable) public void setDbClusterIdentifier(@NotNull String value)
      The name of the primary DB cluster for the DB shard group.

    • getMaxAcu

      @Stability(Stable) @NotNull public Number getMaxAcu()
      The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

    • setMaxAcu

      @Stability(Stable) public void setMaxAcu(@NotNull Number value)
      The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

    • getComputeRedundancy

      @Stability(Stable) @Nullable public Number getComputeRedundancy()
      Specifies whether to create standby standby DB data access shard for the DB shard group.

    • setComputeRedundancy

      @Stability(Stable) public void setComputeRedundancy(@Nullable Number value)
      Specifies whether to create standby standby DB data access shard for the DB shard group.

    • getDbShardGroupIdentifier

      @Stability(Stable) @Nullable public String getDbShardGroupIdentifier()
      The name of the DB shard group.

    • setDbShardGroupIdentifier

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

    • getMinAcu

      @Stability(Stable) @Nullable public Number getMinAcu()
      The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

    • setMinAcu

      @Stability(Stable) public void setMinAcu(@Nullable Number value)
      The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

    • getPubliclyAccessible

      @Stability(Stable) @Nullable public Object getPubliclyAccessible()
      Specifies whether the DB shard group is publicly accessible.

      Returns union: either Boolean or IResolvable

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable Boolean value)
      Specifies whether the DB shard group is publicly accessible.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable IResolvable value)
      Specifies whether the DB shard group is publicly accessible.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.