Package com.pulumi.aws.rds

Class ShardGroup

  • public class ShardGroup
extends com.pulumi.resources.CustomResource
    Resource for managing an Amazon Aurora Limitless Database DB shard group ## Example Usage ### Basic Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import shard group using the `dbShardGroupIdentifier`. For example: ```sh $ pulumi import aws:rds/shardGroup:ShardGroup example example-shard-group ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.Integer> computeRedundancy()  
      com.pulumi.core.Output<java.lang.String> dbClusterIdentifier()  
      com.pulumi.core.Output<java.lang.String> dbShardGroupIdentifier()  
      com.pulumi.core.Output<java.lang.String> dbShardGroupResourceId()  
      com.pulumi.core.Output<java.lang.String> endpoint()  
      static ShardGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ShardGroupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.Double> maxAcu()  
      com.pulumi.core.Output<java.lang.Double> minAcu()  
      com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<ShardGroupTimeouts>> timeouts()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ShardGroup

        public ShardGroup​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ShardGroup

        public ShardGroup​(java.lang.String name,
                  ShardGroupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ShardGroup

        public ShardGroup​(java.lang.String name,
                  ShardGroupArgs args,
                  @Nullable
                  com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the shard group.

      • computeRedundancy

        public com.pulumi.core.Output<java.lang.Integer> computeRedundancy()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> dbClusterIdentifier()
        Returns:
        Name of the primary DB cluster for the DB shard group.

      • dbShardGroupIdentifier

        public com.pulumi.core.Output<java.lang.String> dbShardGroupIdentifier()
        Returns:
        Name of the DB shard group.

      • dbShardGroupResourceId

        public com.pulumi.core.Output<java.lang.String> dbShardGroupResourceId()
        Returns:
        AWS Region-unique, immutable identifier for the DB shard group.

      • endpoint

        public com.pulumi.core.Output<java.lang.String> endpoint()
        Returns:
        Connection endpoint for the DB shard group.

      • maxAcu

        public com.pulumi.core.Output<java.lang.Double> maxAcu()
        Returns:
        Maximum capacity of the DB shard group in Aurora capacity units (ACUs).

      • minAcu

        public com.pulumi.core.Output<java.lang.Double> minAcu()
        Returns:
        Minimum capacity of the DB shard group in Aurora capacity units (ACUs).

      • publiclyAccessible

        public com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible()
        Returns:
        Whether the DB shard group is publicly accessible.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<ShardGroupTimeouts>> timeouts()

      • get

        public static ShardGroup get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             ShardGroupState state,
                             @Nullable
                             com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.