ShardGroup class
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))
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,
});
});
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().ToIDOutput().ToStringOutput(),
MaxAcu: pulumi.Float64(1200),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_rds_cluster" "example" {
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_shardgroup" "example" {
db_shard_group_identifier = "example-shard-group"
db_cluster_identifier = aws_rds_cluster.example.id
max_acu = 1200
}
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.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
Import
Using pulumi import, import shard group using the dbShardGroupIdentifier. For example:
$ pulumi import aws:rds/shardGroup:ShardGroup example example-shard-group
Constructors
- ShardGroup(String name, {ShardGroupArgs? args, CustomResourceOptions? options})
-
Creates a new ShardGroup.
nameThe Pulumi resource name.argsArguments used to configure this ShardGroup. The set of arguments for ShardGroup.optionsResource options controlling this resource's behavior. - ShardGroup.reference(String urn)
- Creates a typed reference to an existing ShardGroup resource.
Properties
-
arn
↔ Output<
String> -
ARN of the shard group.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
computeRedundancy
↔ Output<
int> -
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are:
latefinal
-
dbClusterIdentifier
↔ Output<
String> -
The name of the primary DB cluster for the DB shard group.
latefinal
-
dbShardGroupIdentifier
↔ Output<
String> -
The name of the DB shard group.
latefinal
-
dbShardGroupResourceId
↔ Output<
String> -
The AWS Region-unique, immutable identifier for the DB shard group.
latefinal
-
endpoint
↔ Output<
String> -
The connection endpoint for the DB shard group.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
maxAcu
↔ Output<
double> -
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
latefinal
-
minAcu
↔ Output<
double> -
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
latefinal
-
publiclyAccessible
↔ Output<
bool> -
Indicates whether the DB shard group is publicly accessible.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
ShardGroupTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ShardGroupState? state, CustomResourceOptions? options}) → ShardGroup -
Gets an existing ShardGroup resource's state with the given
nameandid.