Module drds
This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the
pulumi/pulumi-alicloudrepo; however, if that doesn’t turn up anything, please consult the sourceterraform-providers/terraform-provider-alicloudrepo.
Resources
Functions
Others
Resources
Resource Instance
class Instance extends CustomResourceDistributed Relational Database Service (DRDS) is a lightweight (stateless), flexible, stable, and efficient middleware product independently developed by Alibaba Group to resolve scalability issues with single-host relational databases. With its compatibility with MySQL protocols and syntaxes, DRDS enables database/table sharding, smooth scaling, configuration upgrade/downgrade, transparent read/write splitting, and distributed transactions, providing O&M capabilities for distributed databases throughout their entire lifecycle.
For information about DRDS and how to use it, see What is DRDS.
NOTE: At present, DRDS instance only can be supported in the regions: cn-shenzhen, cn-beijing, cn-hangzhou, cn-hongkong, cn-qingdao.
NOTE: Currently, this resource only support
Domestic Site Account.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const defaultInstance = new alicloud.drds.Instance("default", {
description: "drds instance",
instanceChargeType: "PostPaid",
instanceSeries: "drds.sn1.4c8g",
specification: "drds.sn1.4c8g.8C16G",
vswitchId: "vsw-bp1jlu3swk8rq2yoi40ey",
zoneId: "cn-hangzhou-e",
});constructor
new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)Create a Instance resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): InstanceGet an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is InstanceReturns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property description
public description: pulumi.Output<string>;Description of the DRDS instance, This description can have a string of 2 to 256 characters.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property instanceChargeType
public instanceChargeType: pulumi.Output<string | undefined>;Valid values are PrePaid, PostPaid, Default to PostPaid.
property instanceSeries
public instanceSeries: pulumi.Output<string>;User-defined DRDS instance node spec. Value range:
- drds.sn1.4c8g for DRDS instance Starter version;
- drds.sn1.8c16g for DRDS instance Standard edition;
- drds.sn1.16c32g for DRDS instance Enterprise Edition;
- drds.sn1.32c64g for DRDS instance Extreme Edition;
property specification
public specification: pulumi.Output<string>;User-defined DRDS instance specification. Value range:
- drds.sn1.4c8g for DRDS instance Starter version;
- value range : drds.sn1.4c8g.8c16g, drds.sn1.4c8g.16c32g, drds.sn1.4c8g.32c64g, drds.sn1.4c8g.64c128g
- drds.sn1.8c16g for DRDS instance Standard edition;
- value range : drds.sn1.8c16g.16c32g, drds.sn1.8c16g.32c64g, drds.sn1.8c16g.64c128g
- drds.sn1.16c32g for DRDS instance Enterprise Edition;
- value range : drds.sn1.16c32g.32c64g, drds.sn1.16c32g.64c128g
- drds.sn1.32c64g for DRDS instance Extreme Edition;
- value range : drds.sn1.32c64g.128c256g
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
property vswitchId
public vswitchId: pulumi.Output<string | undefined>;The VSwitch ID to launch in.
property zoneId
public zoneId: pulumi.Output<string | undefined>;The Zone to launch the DRDS instance.
Functions
Function getInstances
getInstances(args?: GetInstancesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstancesResult>The alicloud.drds.Instance data source provides a collection of DRDS instances available in Alibaba Cloud account.
Filters support regular expression for the instance name, searches by tags, and other filters which are listed below.
NOTE: Available in 1.35.0+.
Others
interface GetInstancesArgs
interface GetInstancesArgsA collection of arguments for invoking getInstances.
property ids
ids?: string[];A list of DRDS instance IDs.
property nameRegex
nameRegex?: undefined | string;A regex string to filter results by instance name.
property outputFile
outputFile?: undefined | string;interface GetInstancesResult
interface GetInstancesResultA collection of values returned by getInstances.
property descriptions
descriptions: string[];A list of DRDS descriptions.
property id
id: string;The provider-assigned unique ID for this managed resource.
property ids
ids: string[];A list of DRDS instance IDs.
property instances
instances: GetInstancesInstance[];A list of DRDS instances.
property nameRegex
nameRegex?: undefined | string;property outputFile
outputFile?: undefined | string;interface InstanceArgs
interface InstanceArgsThe set of arguments for constructing a Instance resource.
property description
description: pulumi.Input<string>;Description of the DRDS instance, This description can have a string of 2 to 256 characters.
property instanceChargeType
instanceChargeType?: pulumi.Input<string>;Valid values are PrePaid, PostPaid, Default to PostPaid.
property instanceSeries
instanceSeries: pulumi.Input<string>;User-defined DRDS instance node spec. Value range:
- drds.sn1.4c8g for DRDS instance Starter version;
- drds.sn1.8c16g for DRDS instance Standard edition;
- drds.sn1.16c32g for DRDS instance Enterprise Edition;
- drds.sn1.32c64g for DRDS instance Extreme Edition;
property specification
specification: pulumi.Input<string>;User-defined DRDS instance specification. Value range:
- drds.sn1.4c8g for DRDS instance Starter version;
- value range : drds.sn1.4c8g.8c16g, drds.sn1.4c8g.16c32g, drds.sn1.4c8g.32c64g, drds.sn1.4c8g.64c128g
- drds.sn1.8c16g for DRDS instance Standard edition;
- value range : drds.sn1.8c16g.16c32g, drds.sn1.8c16g.32c64g, drds.sn1.8c16g.64c128g
- drds.sn1.16c32g for DRDS instance Enterprise Edition;
- value range : drds.sn1.16c32g.32c64g, drds.sn1.16c32g.64c128g
- drds.sn1.32c64g for DRDS instance Extreme Edition;
- value range : drds.sn1.32c64g.128c256g
property vswitchId
vswitchId?: pulumi.Input<string>;The VSwitch ID to launch in.
property zoneId
zoneId?: pulumi.Input<string>;The Zone to launch the DRDS instance.
interface InstanceState
interface InstanceStateInput properties used for looking up and filtering Instance resources.
property description
description?: pulumi.Input<string>;Description of the DRDS instance, This description can have a string of 2 to 256 characters.
property instanceChargeType
instanceChargeType?: pulumi.Input<string>;Valid values are PrePaid, PostPaid, Default to PostPaid.
property instanceSeries
instanceSeries?: pulumi.Input<string>;User-defined DRDS instance node spec. Value range:
- drds.sn1.4c8g for DRDS instance Starter version;
- drds.sn1.8c16g for DRDS instance Standard edition;
- drds.sn1.16c32g for DRDS instance Enterprise Edition;
- drds.sn1.32c64g for DRDS instance Extreme Edition;
property specification
specification?: pulumi.Input<string>;User-defined DRDS instance specification. Value range:
- drds.sn1.4c8g for DRDS instance Starter version;
- value range : drds.sn1.4c8g.8c16g, drds.sn1.4c8g.16c32g, drds.sn1.4c8g.32c64g, drds.sn1.4c8g.64c128g
- drds.sn1.8c16g for DRDS instance Standard edition;
- value range : drds.sn1.8c16g.16c32g, drds.sn1.8c16g.32c64g, drds.sn1.8c16g.64c128g
- drds.sn1.16c32g for DRDS instance Enterprise Edition;
- value range : drds.sn1.16c32g.32c64g, drds.sn1.16c32g.64c128g
- drds.sn1.32c64g for DRDS instance Extreme Edition;
- value range : drds.sn1.32c64g.128c256g
property vswitchId
vswitchId?: pulumi.Input<string>;The VSwitch ID to launch in.
property zoneId
zoneId?: pulumi.Input<string>;The Zone to launch the DRDS instance.