Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. rds
  6. ShardGroup
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.rds.ShardGroup

aws logo aws logo
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Resource for managing an Amazon Aurora Limitless Database DB shard group

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.rds.Cluster("example", {
    clusterIdentifier: "example-limitless-cluster",
    engine: aws.rds.EngineType.AuroraPostgresql,
    engineVersion: "16.6-limitless",
    engineMode: "",
    storageType: "aurora-iopt1",
    clusterScalabilityType: "limitless",
    masterUsername: "foo",
    masterPassword: "must_be_eight_characters",
    performanceInsightsEnabled: true,
    performanceInsightsRetentionPeriod: 31,
    enabledCloudwatchLogsExports: ["postgresql"],
    monitoringInterval: 5,
    monitoringRoleArn: exampleAwsIamRole.arn,
});
const exampleShardGroup = new aws.rds.ShardGroup("example", {
    dbShardGroupIdentifier: "example-shard-group",
    dbClusterIdentifier: example.id,
    maxAcu: 1200,
});

    import pulumi
import pulumi_aws as aws

example = aws.rds.Cluster("example",
    cluster_identifier="example-limitless-cluster",
    engine=aws.rds.EngineType.AURORA_POSTGRESQL,
    engine_version="16.6-limitless",
    engine_mode="",
    storage_type="aurora-iopt1",
    cluster_scalability_type="limitless",
    master_username="foo",
    master_password="must_be_eight_characters",
    performance_insights_enabled=True,
    performance_insights_retention_period=31,
    enabled_cloudwatch_logs_exports=["postgresql"],
    monitoring_interval=5,
    monitoring_role_arn=example_aws_iam_role["arn"])
example_shard_group = aws.rds.ShardGroup("example",
    db_shard_group_identifier="example-shard-group",
    db_cluster_identifier=example.id,
    max_acu=float(1200))

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := rds.NewCluster(ctx, "example", &rds.ClusterArgs{
			ClusterIdentifier:                  pulumi.String("example-limitless-cluster"),
			Engine:                             pulumi.String(rds.EngineTypeAuroraPostgresql),
			EngineVersion:                      pulumi.String("16.6-limitless"),
			EngineMode:                         pulumi.String(""),
			StorageType:                        pulumi.String("aurora-iopt1"),
			ClusterScalabilityType:             pulumi.String("limitless"),
			MasterUsername:                     pulumi.String("foo"),
			MasterPassword:                     pulumi.String("must_be_eight_characters"),
			PerformanceInsightsEnabled:         pulumi.Bool(true),
			PerformanceInsightsRetentionPeriod: pulumi.Int(31),
			EnabledCloudwatchLogsExports: pulumi.StringArray{
				pulumi.String("postgresql"),
			},
			MonitoringInterval: pulumi.Int(5),
			MonitoringRoleArn:  pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewShardGroup(ctx, "example", &rds.ShardGroupArgs{
			DbShardGroupIdentifier: pulumi.String("example-shard-group"),
			DbClusterIdentifier:    example.ID(),
			MaxAcu:                 pulumi.Float64(1200),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Rds.Cluster("example", new()
    {
        ClusterIdentifier = "example-limitless-cluster",
        Engine = Aws.Rds.EngineType.AuroraPostgresql,
        EngineVersion = "16.6-limitless",
        EngineMode = "",
        StorageType = "aurora-iopt1",
        ClusterScalabilityType = "limitless",
        MasterUsername = "foo",
        MasterPassword = "must_be_eight_characters",
        PerformanceInsightsEnabled = true,
        PerformanceInsightsRetentionPeriod = 31,
        EnabledCloudwatchLogsExports = new[]
        {
            "postgresql",
        },
        MonitoringInterval = 5,
        MonitoringRoleArn = exampleAwsIamRole.Arn,
    });

    var exampleShardGroup = new Aws.Rds.ShardGroup("example", new()
    {
        DbShardGroupIdentifier = "example-shard-group",
        DbClusterIdentifier = example.Id,
        MaxAcu = 1200.0,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Cluster;
import com.pulumi.aws.rds.ClusterArgs;
import com.pulumi.aws.rds.ShardGroup;
import com.pulumi.aws.rds.ShardGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Cluster("example", ClusterArgs.builder()
            .clusterIdentifier("example-limitless-cluster")
            .engine("aurora-postgresql")
            .engineVersion("16.6-limitless")
            .engineMode("")
            .storageType("aurora-iopt1")
            .clusterScalabilityType("limitless")
            .masterUsername("foo")
            .masterPassword("must_be_eight_characters")
            .performanceInsightsEnabled(true)
            .performanceInsightsRetentionPeriod(31)
            .enabledCloudwatchLogsExports("postgresql")
            .monitoringInterval(5)
            .monitoringRoleArn(exampleAwsIamRole.get("arn"))
            .build());

        var exampleShardGroup = new ShardGroup("exampleShardGroup", ShardGroupArgs.builder()
            .dbShardGroupIdentifier("example-shard-group")
            .dbClusterIdentifier(example.id())
            .maxAcu(1200.0)
            .build());

    }
}

    resources:
  example:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: example-limitless-cluster
      engine: aurora-postgresql
      engineVersion: 16.6-limitless
      engineMode: ""
      storageType: aurora-iopt1
      clusterScalabilityType: limitless
      masterUsername: foo
      masterPassword: must_be_eight_characters
      performanceInsightsEnabled: true
      performanceInsightsRetentionPeriod: 31
      enabledCloudwatchLogsExports:
        - postgresql
      monitoringInterval: 5
      monitoringRoleArn: ${exampleAwsIamRole.arn}
  exampleShardGroup:
    type: aws:rds:ShardGroup
    name: example
    properties:
      dbShardGroupIdentifier: example-shard-group
      dbClusterIdentifier: ${example.id}
      maxAcu: 1200

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_cluster" "example" {
  lifecycle {
    create_before_destroy = true
  }
  cluster_identifier                    = "example-limitless-cluster"
  engine                                = "aurora-postgresql"
  engine_version                        = "16.6-limitless"
  engine_mode                           = ""
  storage_type                          = "aurora-iopt1"
  cluster_scalability_type              = "limitless"
  master_username                       = "foo"
  master_password                       = "must_be_eight_characters"
  performance_insights_enabled          = true
  performance_insights_retention_period = 31
  enabled_cloudwatch_logs_exports       = ["postgresql"]
  monitoring_interval                   = 5
  monitoring_role_arn                   = exampleAwsIamRole.arn
}
resource "aws_rds_shard_group" "example" {
  lifecycle {
    create_before_destroy = true
  }
  db_shard_group_identifier = "example-shard-group"
  db_cluster_identifier     = aws_rds_cluster.example.id
  max_acu                   = 1200
}

    Create ShardGroup Resource

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

    Constructor syntax

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

@overload
def ShardGroup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               db_cluster_identifier: Optional[str] = None,
               db_shard_group_identifier: Optional[str] = None,
               max_acu: Optional[float] = None,
               compute_redundancy: Optional[int] = None,
               min_acu: Optional[float] = None,
               publicly_accessible: Optional[bool] = None,
               region: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               timeouts: Optional[ShardGroupTimeoutsArgs] = None)
    func NewShardGroup(ctx *Context, name string, args ShardGroupArgs, opts ...ResourceOption) (*ShardGroup, error)
    public ShardGroup(string name, ShardGroupArgs args, CustomResourceOptions? opts = null)
    public ShardGroup(String name, ShardGroupArgs args)
public ShardGroup(String name, ShardGroupArgs args, CustomResourceOptions options)

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


    resource "aws_rds_shard_group" "name" {
    # resource properties
}

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var shardGroupResource = new Aws.Rds.ShardGroup("shardGroupResource", new()
{
    DbClusterIdentifier = "string",
    DbShardGroupIdentifier = "string",
    MaxAcu = 0.0,
    ComputeRedundancy = 0,
    MinAcu = 0.0,
    PubliclyAccessible = false,
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Rds.Inputs.ShardGroupTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := rds.NewShardGroup(ctx, "shardGroupResource", &rds.ShardGroupArgs{
	DbClusterIdentifier:    pulumi.String("string"),
	DbShardGroupIdentifier: pulumi.String("string"),
	MaxAcu:                 pulumi.Float64(0),
	ComputeRedundancy:      pulumi.Int(0),
	MinAcu:                 pulumi.Float64(0),
	PubliclyAccessible:     pulumi.Bool(false),
	Region:                 pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &rds.ShardGroupTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    resource "aws_rds_shard_group" "shardGroupResource" {
  lifecycle {
    create_before_destroy = true
  }
  db_cluster_identifier     = "string"
  db_shard_group_identifier = "string"
  max_acu                   = 0
  compute_redundancy        = 0
  min_acu                   = 0
  publicly_accessible       = false
  region                    = "string"
  tags = {
    "string" = "string"
  }
  timeouts = {
    create = "string"
    delete = "string"
    update = "string"
  }
}

    var shardGroupResource = new ShardGroup("shardGroupResource", ShardGroupArgs.builder()
    .dbClusterIdentifier("string")
    .dbShardGroupIdentifier("string")
    .maxAcu(0.0)
    .computeRedundancy(0)
    .minAcu(0.0)
    .publiclyAccessible(false)
    .region("string")
    .tags(Map.of("string", "string"))
    .timeouts(ShardGroupTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    shard_group_resource = aws.rds.ShardGroup("shardGroupResource",
    db_cluster_identifier="string",
    db_shard_group_identifier="string",
    max_acu=float(0),
    compute_redundancy=0,
    min_acu=float(0),
    publicly_accessible=False,
    region="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const shardGroupResource = new aws.rds.ShardGroup("shardGroupResource", {
    dbClusterIdentifier: "string",
    dbShardGroupIdentifier: "string",
    maxAcu: 0,
    computeRedundancy: 0,
    minAcu: 0,
    publiclyAccessible: false,
    region: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: aws:rds:ShardGroup
properties:
    computeRedundancy: 0
    dbClusterIdentifier: string
    dbShardGroupIdentifier: string
    maxAcu: 0
    minAcu: 0
    publiclyAccessible: false
    region: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string

    ShardGroup 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 ShardGroup resource accepts the following input properties:

    DbClusterIdentifier string
    Name of the primary DB cluster for the DB shard group.
    DbShardGroupIdentifier string
    Name of the DB shard group.
    MaxAcu double
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    ComputeRedundancy int
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    MinAcu double
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    PubliclyAccessible bool
    Whether the DB shard group is publicly accessible.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts ShardGroupTimeouts
    DbClusterIdentifier string
    Name of the primary DB cluster for the DB shard group.
    DbShardGroupIdentifier string
    Name of the DB shard group.
    MaxAcu float64
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    ComputeRedundancy int
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    MinAcu float64
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    PubliclyAccessible bool
    Whether the DB shard group is publicly accessible.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts ShardGroupTimeoutsArgs
    db_cluster_identifier string
    Name of the primary DB cluster for the DB shard group.
    db_shard_group_identifier string
    Name of the DB shard group.
    max_acu number
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    compute_redundancy number
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    min_acu number
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publicly_accessible bool
    Whether the DB shard group is publicly accessible.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts object
    dbClusterIdentifier String
    Name of the primary DB cluster for the DB shard group.
    dbShardGroupIdentifier String
    Name of the DB shard group.
    maxAcu Double
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    computeRedundancy Integer
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    minAcu Double
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publiclyAccessible Boolean
    Whether the DB shard group is publicly accessible.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts ShardGroupTimeouts
    dbClusterIdentifier string
    Name of the primary DB cluster for the DB shard group.
    dbShardGroupIdentifier string
    Name of the DB shard group.
    maxAcu number
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    computeRedundancy number
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    minAcu number
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publiclyAccessible boolean
    Whether the DB shard group is publicly accessible.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts ShardGroupTimeouts
    db_cluster_identifier str
    Name of the primary DB cluster for the DB shard group.
    db_shard_group_identifier str
    Name of the DB shard group.
    max_acu float
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    compute_redundancy int
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    min_acu float
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publicly_accessible bool
    Whether the DB shard group is publicly accessible.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts ShardGroupTimeoutsArgs
    dbClusterIdentifier String
    Name of the primary DB cluster for the DB shard group.
    dbShardGroupIdentifier String
    Name of the DB shard group.
    maxAcu Number
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    computeRedundancy Number
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    minAcu Number
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publiclyAccessible Boolean
    Whether the DB shard group is publicly accessible.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

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

    Arn string
    ARN of the shard group.
    DbShardGroupResourceId string
    AWS Region-unique, immutable identifier for the DB shard group.
    Endpoint string
    Connection endpoint for the DB shard group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    ARN of the shard group.
    DbShardGroupResourceId string
    AWS Region-unique, immutable identifier for the DB shard group.
    Endpoint string
    Connection endpoint for the DB shard group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the shard group.
    db_shard_group_resource_id string
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint string
    Connection endpoint for the DB shard group.
    id string
    The provider-assigned unique ID for this managed resource.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the shard group.
    dbShardGroupResourceId String
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint String
    Connection endpoint for the DB shard group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the shard group.
    dbShardGroupResourceId string
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint string
    Connection endpoint for the DB shard group.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    ARN of the shard group.
    db_shard_group_resource_id str
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint str
    Connection endpoint for the DB shard group.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the shard group.
    dbShardGroupResourceId String
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint String
    Connection endpoint for the DB shard group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Look up Existing ShardGroup Resource

    Get an existing ShardGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ShardGroupState, opts?: CustomResourceOptions): ShardGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        compute_redundancy: Optional[int] = None,
        db_cluster_identifier: Optional[str] = None,
        db_shard_group_identifier: Optional[str] = None,
        db_shard_group_resource_id: Optional[str] = None,
        endpoint: Optional[str] = None,
        max_acu: Optional[float] = None,
        min_acu: Optional[float] = None,
        publicly_accessible: Optional[bool] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[ShardGroupTimeoutsArgs] = None) -> ShardGroup
    func GetShardGroup(ctx *Context, name string, id IDInput, state *ShardGroupState, opts ...ResourceOption) (*ShardGroup, error)
    public static ShardGroup Get(string name, Input<string> id, ShardGroupState? state, CustomResourceOptions? opts = null)
    public static ShardGroup get(String name, Output<String> id, ShardGroupState state, CustomResourceOptions options)
    resources:  _:    type: aws:rds:ShardGroup    get:      id: ${id}
    import {
  to = aws_rds_shard_group.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the shard group.
    ComputeRedundancy int
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    DbClusterIdentifier string
    Name of the primary DB cluster for the DB shard group.
    DbShardGroupIdentifier string
    Name of the DB shard group.
    DbShardGroupResourceId string
    AWS Region-unique, immutable identifier for the DB shard group.
    Endpoint string
    Connection endpoint for the DB shard group.
    MaxAcu double
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    MinAcu double
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    PubliclyAccessible bool
    Whether the DB shard group is publicly accessible.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Timeouts ShardGroupTimeouts
    Arn string
    ARN of the shard group.
    ComputeRedundancy int
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    DbClusterIdentifier string
    Name of the primary DB cluster for the DB shard group.
    DbShardGroupIdentifier string
    Name of the DB shard group.
    DbShardGroupResourceId string
    AWS Region-unique, immutable identifier for the DB shard group.
    Endpoint string
    Connection endpoint for the DB shard group.
    MaxAcu float64
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    MinAcu float64
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    PubliclyAccessible bool
    Whether the DB shard group is publicly accessible.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Timeouts ShardGroupTimeoutsArgs
    arn string
    ARN of the shard group.
    compute_redundancy number
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    db_cluster_identifier string
    Name of the primary DB cluster for the DB shard group.
    db_shard_group_identifier string
    Name of the DB shard group.
    db_shard_group_resource_id string
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint string
    Connection endpoint for the DB shard group.
    max_acu number
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    min_acu number
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publicly_accessible bool
    Whether the DB shard group is publicly accessible.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts object
    arn String
    ARN of the shard group.
    computeRedundancy Integer
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    dbClusterIdentifier String
    Name of the primary DB cluster for the DB shard group.
    dbShardGroupIdentifier String
    Name of the DB shard group.
    dbShardGroupResourceId String
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint String
    Connection endpoint for the DB shard group.
    maxAcu Double
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    minAcu Double
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publiclyAccessible Boolean
    Whether the DB shard group is publicly accessible.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts ShardGroupTimeouts
    arn string
    ARN of the shard group.
    computeRedundancy number
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    dbClusterIdentifier string
    Name of the primary DB cluster for the DB shard group.
    dbShardGroupIdentifier string
    Name of the DB shard group.
    dbShardGroupResourceId string
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint string
    Connection endpoint for the DB shard group.
    maxAcu number
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    minAcu number
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publiclyAccessible boolean
    Whether the DB shard group is publicly accessible.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts ShardGroupTimeouts
    arn str
    ARN of the shard group.
    compute_redundancy int
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    db_cluster_identifier str
    Name of the primary DB cluster for the DB shard group.
    db_shard_group_identifier str
    Name of the DB shard group.
    db_shard_group_resource_id str
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint str
    Connection endpoint for the DB shard group.
    max_acu float
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    min_acu float
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publicly_accessible bool
    Whether the DB shard group is publicly accessible.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts ShardGroupTimeoutsArgs
    arn String
    ARN of the shard group.
    computeRedundancy Number
    Whether to create standby DB shard groups for the DB shard group. Valid values are 0 (no standby DB shard group, the default), 1 (one standby DB shard group in a different Availability Zone), and 2 (two standby DB shard groups in two different Availability Zones).
    dbClusterIdentifier String
    Name of the primary DB cluster for the DB shard group.
    dbShardGroupIdentifier String
    Name of the DB shard group.
    dbShardGroupResourceId String
    AWS Region-unique, immutable identifier for the DB shard group.
    endpoint String
    Connection endpoint for the DB shard group.
    maxAcu Number
    Maximum capacity of the DB shard group in Aurora capacity units (ACUs).
    minAcu Number
    Minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    publiclyAccessible Boolean
    Whether the DB shard group is publicly accessible.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts Property Map

    Supporting Types

    ShardGroupTimeouts, ShardGroupTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import shard group using the dbShardGroupIdentifier. For example:

    $ pulumi import aws:rds/shardGroup:ShardGroup example example-shard-group

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.52.1
    published on Wednesday, Oct 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial