Package com.pulumi.aws.dsql

Class Cluster

  • public class Cluster
extends com.pulumi.resources.CustomResource
    Resource for managing an Amazon Aurora DSQL Cluster. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.dsql.Cluster;
 import com.pulumi.aws.dsql.ClusterArgs;
 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()
             .deletionProtectionEnabled(true)
             .tags(Map.of("Name", "TestCluster"))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `identifier` (String) Cluster Identifier. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import DSQL Cluster using the `identifier`. For example: ```sh $ pulumi import aws:dsql/cluster:Cluster example abcde1f234ghijklmnop5qr6st ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Cluster​(java.lang.String name)  
      Cluster​(java.lang.String name, ClusterArgs args)  
      Cluster​(java.lang.String name, ClusterArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • 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.Boolean> deletionProtectionEnabled()  
      com.pulumi.core.Output<java.util.List<ClusterEncryptionDetail>> encryptionDetails()  
      com.pulumi.core.Output<java.lang.Boolean> forceDestroy()  
      static Cluster get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ClusterState 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.String> identifier()  
      com.pulumi.core.Output<java.lang.String> kmsEncryptionKey()  
      com.pulumi.core.Output<java.util.Optional<ClusterMultiRegionProperties>> multiRegionProperties()  
      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<ClusterTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.String> vpcEndpointServiceName()  

      • 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

      • Cluster

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

      • Cluster

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

      • Cluster

        public Cluster​(java.lang.String name,
               @Nullable
               ClusterArgs 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 Cluster.

      • deletionProtectionEnabled

        public com.pulumi.core.Output<java.lang.Boolean> deletionProtectionEnabled()
        Returns:
        Whether deletion protection is enabled in this cluster. Default value is `false`.

      • encryptionDetails

        public com.pulumi.core.Output<java.util.List<ClusterEncryptionDetail>> encryptionDetails()
        Returns:
        Encryption configuration details for the DSQL Cluster.

      • forceDestroy

        public com.pulumi.core.Output<java.lang.Boolean> forceDestroy()
        Returns:
        Destroys cluster even if `deletionProtectionEnabled` is set to `true`. Default value is `false`.

      • identifier

        public com.pulumi.core.Output<java.lang.String> identifier()
        Returns:
        Cluster Identifier.

      • kmsEncryptionKey

        public com.pulumi.core.Output<java.lang.String> kmsEncryptionKey()
        Returns:
        The ARN of the AWS KMS key that encrypts data in the DSQL Cluster, or `"AWS_OWNED_KMS_KEY"`.

      • multiRegionProperties

        public com.pulumi.core.Output<java.util.Optional<ClusterMultiRegionProperties>> multiRegionProperties()
        Returns:
        Multi-region properties of the DSQL Cluster.

      • 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:
        Set of tags to be associated with the AWS DSQL Cluster resource.

      • 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<ClusterTimeouts>> timeouts()

      • vpcEndpointServiceName

        public com.pulumi.core.Output<java.lang.String> vpcEndpointServiceName()
        Returns:
        The DSQL Cluster's VPC endpoint service name.

      • get

        public static Cluster get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          ClusterState 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.