Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. DbShardGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.DbShardGroup

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

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

Create DbShardGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DbShardGroup(name: string, args: DbShardGroupArgs, opts?: CustomResourceOptions);
@overload
def DbShardGroup(resource_name: str,
                 args: DbShardGroupArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def DbShardGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 db_cluster_identifier: Optional[str] = None,
                 max_acu: Optional[float] = None,
                 compute_redundancy: Optional[int] = None,
                 db_shard_group_identifier: Optional[str] = None,
                 min_acu: Optional[float] = None,
                 publicly_accessible: Optional[bool] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewDbShardGroup(ctx *Context, name string, args DbShardGroupArgs, opts ...ResourceOption) (*DbShardGroup, error)
public DbShardGroup(string name, DbShardGroupArgs args, CustomResourceOptions? opts = null)
public DbShardGroup(String name, DbShardGroupArgs args)
public DbShardGroup(String name, DbShardGroupArgs args, CustomResourceOptions options)

type: aws-native:rds:DbShardGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DbShardGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DbShardGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DbShardGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DbShardGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DbShardGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DbShardGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DbShardGroup resource accepts the following input properties:

DbClusterIdentifier This property is required. string
The name of the primary DB cluster for the DB shard group.
MaxAcu This property is required. double
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
ComputeRedundancy int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

  • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
  • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
  • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
DbShardGroupIdentifier string
The name of the DB shard group.
MinAcu double
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
PubliclyAccessible bool

Specifies whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it. When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
DbClusterIdentifier This property is required. string
The name of the primary DB cluster for the DB shard group.
MaxAcu This property is required. float64
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
ComputeRedundancy int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

  • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
  • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
  • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
DbShardGroupIdentifier string
The name of the DB shard group.
MinAcu float64
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
PubliclyAccessible bool

Specifies whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it. When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
Tags TagArgs
An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
dbClusterIdentifier This property is required. String
The name of the primary DB cluster for the DB shard group.
maxAcu This property is required. Double
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
computeRedundancy Integer
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

  • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
  • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
  • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
dbShardGroupIdentifier String
The name of the DB shard group.
minAcu Double
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
publiclyAccessible Boolean

Specifies whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it. When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
tags List<Tag>
An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
dbClusterIdentifier This property is required. string
The name of the primary DB cluster for the DB shard group.
maxAcu This property is required. number
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
computeRedundancy number
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

  • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
  • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
  • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
dbShardGroupIdentifier string
The name of the DB shard group.
minAcu number
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
publiclyAccessible boolean

Specifies whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it. When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
tags Tag[]
An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
db_cluster_identifier This property is required. str
The name of the primary DB cluster for the DB shard group.
max_acu This property is required. float
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
compute_redundancy int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

  • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
  • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
  • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
db_shard_group_identifier str
The name of the DB shard group.
min_acu float
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
publicly_accessible bool

Specifies whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it. When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
tags Sequence[TagArgs]
An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
dbClusterIdentifier This property is required. String
The name of the primary DB cluster for the DB shard group.
maxAcu This property is required. Number
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
computeRedundancy Number
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

  • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
  • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
  • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
dbShardGroupIdentifier String
The name of the DB shard group.
minAcu Number
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
publiclyAccessible Boolean

Specifies whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it. When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
tags List<Property Map>
An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.

Outputs

All input properties are implicitly available as output properties. Additionally, the DbShardGroup resource produces the following output properties:

DbShardGroupResourceId string
The AWS Region -unique, immutable identifier for the DB shard group.
Endpoint string

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 .

Id string
The provider-assigned unique ID for this managed resource.
DbShardGroupResourceId string
The AWS Region -unique, immutable identifier for the DB shard group.
Endpoint string

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 .

Id string
The provider-assigned unique ID for this managed resource.
dbShardGroupResourceId String
The AWS Region -unique, immutable identifier for the DB shard group.
endpoint String

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 .

id String
The provider-assigned unique ID for this managed resource.
dbShardGroupResourceId string
The AWS Region -unique, immutable identifier for the DB shard group.
endpoint string

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 .

id string
The provider-assigned unique ID for this managed resource.
db_shard_group_resource_id str
The AWS Region -unique, immutable identifier for the DB shard group.
endpoint str

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 .

id str
The provider-assigned unique ID for this managed resource.
dbShardGroupResourceId String
The AWS Region -unique, immutable identifier for the DB shard group.
endpoint String

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 .

id String
The provider-assigned unique ID for this managed resource.

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native