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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.getDbShardGroup

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 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

    Using getDbShardGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDbShardGroup(args: GetDbShardGroupArgs, opts?: InvokeOptions): Promise<GetDbShardGroupResult>
function getDbShardGroupOutput(args: GetDbShardGroupOutputArgs, opts?: InvokeOptions): Output<GetDbShardGroupResult>
    def get_db_shard_group(db_shard_group_identifier: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDbShardGroupResult
def get_db_shard_group_output(db_shard_group_identifier: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDbShardGroupResult]
    func LookupDbShardGroup(ctx *Context, args *LookupDbShardGroupArgs, opts ...InvokeOption) (*LookupDbShardGroupResult, error)
func LookupDbShardGroupOutput(ctx *Context, args *LookupDbShardGroupOutputArgs, opts ...InvokeOption) LookupDbShardGroupResultOutput

    > Note: This function is named LookupDbShardGroup in the Go SDK.

    public static class GetDbShardGroup 
{
    public static Task<GetDbShardGroupResult> InvokeAsync(GetDbShardGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetDbShardGroupResult> Invoke(GetDbShardGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDbShardGroupResult> getDbShardGroup(GetDbShardGroupArgs args, InvokeOptions options)
public static Output<GetDbShardGroupResult> getDbShardGroup(GetDbShardGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:rds:getDbShardGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DbShardGroupIdentifier string
    The name of the DB shard group.
    DbShardGroupIdentifier string
    The name of the DB shard group.
    dbShardGroupIdentifier String
    The name of the DB shard group.
    dbShardGroupIdentifier string
    The name of the DB shard group.
    db_shard_group_identifier str
    The name of the DB shard group.
    dbShardGroupIdentifier String
    The name of the DB shard group.

    getDbShardGroup Result

    The following output properties are available:

    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.
    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 .

    MaxAcu double
    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
    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.
    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 .

    MaxAcu float64
    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    Tags Tag
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
    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.
    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 .

    maxAcu Double
    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    tags List<Tag>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
    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.
    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 .

    maxAcu number
    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    tags Tag[]
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
    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_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 .

    max_acu float
    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    tags Sequence[root_Tag]
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
    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.
    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 .

    maxAcu Number
    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    tags List<Property Map>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native