Package com.pulumi.alicloud.adb

Class DBCluster

  • public class DBCluster
extends com.pulumi.resources.CustomResource
    ## Import AnalyticDB for MySQL (ADB) DBCluster can be imported using the id, e.g. ```sh $ pulumi import alicloud:adb/dBCluster:DBCluster example <id> ```

    • 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
      DBCluster​(java.lang.String name)  
      DBCluster​(java.lang.String name, DBClusterArgs args)  
      DBCluster​(java.lang.String name, DBClusterArgs 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.Integer> autoRenewPeriod()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> computeResource()  
      com.pulumi.core.Output<java.lang.String> connectionString()  
      com.pulumi.core.Output<java.lang.String> dbClusterCategory()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> dbClusterClass()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> dbClusterVersion()  
      com.pulumi.core.Output<java.lang.String> dbNodeClass()  
      com.pulumi.core.Output<java.lang.Integer> dbNodeCount()  
      com.pulumi.core.Output<java.lang.Integer> dbNodeStorage()  
      com.pulumi.core.Output<java.lang.String> description()  
      com.pulumi.core.Output<java.lang.String> diskPerformanceLevel()  
      com.pulumi.core.Output<java.lang.Integer> elasticIoResource()  
      com.pulumi.core.Output<java.lang.String> elasticIoResourceSize()  
      static DBCluster get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DBClusterState 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> maintainTime()  
      com.pulumi.core.Output<java.lang.String> mode()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> modifyType()  
      com.pulumi.core.Output<java.lang.String> paymentType()  
      com.pulumi.core.Output<java.lang.String> payType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> period()  
      com.pulumi.core.Output<java.lang.String> port()  
      com.pulumi.core.Output<java.lang.String> renewalStatus()  
      com.pulumi.core.Output<java.lang.String> resourceGroupId()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> securityIps()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> tags()  
      com.pulumi.core.Output<java.lang.String> vpcId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> vswitchId()  
      com.pulumi.core.Output<java.lang.String> zoneId()  

      • 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

      • DBCluster

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

      • DBCluster

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

      • DBCluster

        public DBCluster​(java.lang.String name,
                 DBClusterArgs 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

      • autoRenewPeriod

        public com.pulumi.core.Output<java.lang.Integer> autoRenewPeriod()
        Returns:
        Auto-renewal period of an cluster, in the unit of the month. It is valid when `payment_type` is `Subscription`. Valid values: `1`, `2`, `3`, `6`, `12`, `24`, `36`. Default Value: `1`.

      • computeResource

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> computeResource()
        Returns:
        The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see [ComputeResource](https://www.alibabacloud.com/help/en/analyticdb-for-mysql/developer-reference/api-adb-2019-03-15-describecomputeresource)

      • connectionString

        public com.pulumi.core.Output<java.lang.String> connectionString()
        Returns:
        The connection string of the cluster.

      • dbClusterCategory

        public com.pulumi.core.Output<java.lang.String> dbClusterCategory()
        Returns:
        The db cluster category. Valid values: `Basic`, `Cluster`, `MixedStorage`.

      • dbClusterClass

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> dbClusterClass()
        Returns:
        It duplicates with attribute db_node_class and is deprecated from 1.121.2.

      • dbClusterVersion

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> dbClusterVersion()
        Returns:
        The db cluster version. Valid values: `3.0`. Default Value: `3.0`.

      • dbNodeClass

        public com.pulumi.core.Output<java.lang.String> dbNodeClass()
        Returns:
        The db node class. For more information, see [DBClusterClass](https://help.aliyun.com/document_detail/190519.html)

      • dbNodeCount

        public com.pulumi.core.Output<java.lang.Integer> dbNodeCount()
        Returns:
        The db node count.

      • dbNodeStorage

        public com.pulumi.core.Output<java.lang.Integer> dbNodeStorage()
        Returns:
        The db node storage.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        The description of DBCluster.

      • diskPerformanceLevel

        public com.pulumi.core.Output<java.lang.String> diskPerformanceLevel()
        Returns:
        The ESSD performance level. Default Value: `PL1`. Valid values: `PL1`, `PL2`, `PL3`.

      • elasticIoResource

        public com.pulumi.core.Output<java.lang.Integer> elasticIoResource()
        Returns:
        The elastic io resource.

      • elasticIoResourceSize

        public com.pulumi.core.Output<java.lang.String> elasticIoResourceSize()
        Returns:
        The specifications of a single elastic resource node. Default Value: `8Core64GB`. Valid values:

      • maintainTime

        public com.pulumi.core.Output<java.lang.String> maintainTime()
        Returns:
        The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.

      • mode

        public com.pulumi.core.Output<java.lang.String> mode()
        Returns:
        The mode of the cluster. Valid values: `reserver`, `flexible`.

      • modifyType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> modifyType()
        Returns:
        The modify type.

      • payType

        public com.pulumi.core.Output<java.lang.String> payType()
        Returns:
        Field `pay_type` has been deprecated. New field `payment_type` instead.

      • paymentType

        public com.pulumi.core.Output<java.lang.String> paymentType()
        Returns:
        The payment type of the resource. Valid values: `PayAsYouGo` and `Subscription`. Default Value: `PayAsYouGo`. **Note:** The `payment_type` supports updating from v1.166.0+.

      • period

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> period()
        Returns:
        The duration that you will buy DB cluster (in month). It is valid when `payment_type` is `Subscription`. Valid values: [1~9], 12, 24, 36. > **NOTE:** The attribute `period` is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running `pulumi up` will not affect the resource.

      • port

        public com.pulumi.core.Output<java.lang.String> port()
        Returns:
        (Available since v1.196.0) The connection port of the ADB cluster.

      • renewalStatus

        public com.pulumi.core.Output<java.lang.String> renewalStatus()
        Returns:
        Valid values are `AutoRenewal`, `Normal`, `NotRenewal`, Default to `NotRenewal`.

      • resourceGroupId

        public com.pulumi.core.Output<java.lang.String> resourceGroupId()
        Returns:
        The ID of the resource group.

      • securityIps

        public com.pulumi.core.Output<java.util.List<java.lang.String>> securityIps()
        Returns:
        List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        The status of the resource.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> tags()
        Returns:
        A mapping of tags to assign to the resource. - Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string. - Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string. > **NOTE:** Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.

      • vpcId

        public com.pulumi.core.Output<java.lang.String> vpcId()
        Returns:
        The vpc ID of the resource.

      • vswitchId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> vswitchId()
        Returns:
        The vswitch id.

      • zoneId

        public com.pulumi.core.Output<java.lang.String> zoneId()
        Returns:
        The zone ID of the resource.

      • get

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