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.

gpdb¶

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-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.gpdb.AwaitableGetInstancesResult(availability_zone=None, id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None, tags=None, vswitch_id=None)¶

class pulumi_alicloud.gpdb.AwaitableGetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

class pulumi_alicloud.gpdb.Connection(resource_name, opts=None, connection_prefix=None, instance_id=None, port=None, __props__=None, __name__=None, __opts__=None)¶

Provides a connection resource to allocate an Internet connection string for instance.

NOTE: Available in 1.48.0+
NOTE: Each instance will allocate a intranet connection string automatically and its prefix is instance ID.
To avoid unnecessary conflict, please specified a internet connection prefix before applying the resource.

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
creation = config.get("creation")
if creation is None:
    creation = "Gpdb"
name = config.get("name")
if name is None:
    name = "gpdbConnectionBasic"
default_zones = alicloud.get_zones(available_resource_creation=creation)
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.gpdb.Instance("defaultInstance",
    description=name,
    engine="gpdb",
    engine_version="4.3",
    instance_class="gpdb.group.segsdx2",
    instance_group_count="2",
    vswitch_id=default_switch.id)
default_connection = alicloud.gpdb.Connection("defaultConnection",
    connection_prefix="testAbc",
    instance_id=default_instance.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_prefix (pulumi.Input[str]) – Prefix of an Internet connection string. It must be checked for uniqueness. It may consist of lowercase letters, numbers, and underlines, and must start with a letter and have no more than 30 characters. Default to + ‘-tf’.
instance_id (pulumi.Input[str]) – The Id of instance that can run database.
port (pulumi.Input[str]) – Internet connection port. Valid value: [3200-3999]. Default to 3306.

connection_prefix: pulumi.Output[str] = None¶: Prefix of an Internet connection string. It must be checked for uniqueness. It may consist of lowercase letters, numbers, and underlines, and must start with a letter and have no more than 30 characters. Default to + ‘-tf’.

connection_string: pulumi.Output[str] = None¶: Connection instance string.

instance_id: pulumi.Output[str] = None¶: The Id of instance that can run database.

ip_address: pulumi.Output[str] = None¶: The ip address of connection string.

port: pulumi.Output[str] = None¶: Internet connection port. Valid value: [3200-3999]. Default to 3306.

static get(resource_name, id, opts=None, connection_prefix=None, connection_string=None, instance_id=None, ip_address=None, port=None)¶

Get an existing Connection resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_prefix (pulumi.Input[str]) – Prefix of an Internet connection string. It must be checked for uniqueness. It may consist of lowercase letters, numbers, and underlines, and must start with a letter and have no more than 30 characters. Default to + ‘-tf’.
connection_string (pulumi.Input[str]) – Connection instance string.
instance_id (pulumi.Input[str]) – The Id of instance that can run database.
ip_address (pulumi.Input[str]) – The ip address of connection string.
port (pulumi.Input[str]) – Internet connection port. Valid value: [3200-3999]. Default to 3306.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.gpdb.GetInstancesResult(availability_zone=None, id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None, tags=None, vswitch_id=None)¶

A collection of values returned by getInstances.

availability_zone = None¶: Instance availability zone.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: The ids list of AnalyticDB for PostgreSQL instances.

instances = None¶: A list of AnalyticDB for PostgreSQL instances. Its every element contains the following attributes:

names = None¶: The names list of AnalyticDB for PostgreSQL instance.

class pulumi_alicloud.gpdb.GetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

A collection of values returned by getZones.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of zone IDs.

zones = None¶: A list of availability zones. Each element contains the following attributes:

class pulumi_alicloud.gpdb.Instance(resource_name, opts=None, availability_zone=None, description=None, engine=None, engine_version=None, instance_charge_type=None, instance_class=None, instance_group_count=None, security_ip_lists=None, tags=None, vswitch_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a AnalyticDB for PostgreSQL instance resource supports replica set instances only. the AnalyticDB for PostgreSQL provides stable, reliable, and automatic scalable database services. You can see detail product introduction here

NOTE: Available in 1.47.0+
NOTE: The following regions don’t support create Classic network Gpdb instance. [ap-southeast-2,ap-southeast-3,ap-southeast-5,ap-south-1,me-east-1,ap-northeast-1,eu-west-1,us-east-1,eu-central-1,cn-shanghai-finance-1,cn-shenzhen-finance-1,cn-hangzhou-finance]
NOTE: Create instance or change instance would cost 10~15 minutes. Please make full preparation.

import pulumi
import pulumi_alicloud as alicloud

default_zones = alicloud.get_zones(available_resource_creation="Gpdb")
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
example = alicloud.gpdb.Instance("example",
    description="tf-gpdb-test",
    engine="gpdb",
    engine_version="4.3",
    instance_class="gpdb.group.segsdx2",
    instance_group_count="2",
    security_ip_lists=[
        "10.168.1.12",
        "100.69.7.112",
    ],
    vswitch_id=default_switch.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The name of DB instance. It a string of 2 to 256 characters.
engine (pulumi.Input[str]) – Database engine: gpdb. System Default value: gpdb.
engine_version (pulumi.Input[str]) – Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
instance_charge_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid,System default to PostPaid.
instance_class (pulumi.Input[str]) – Instance specification. see Instance specifications.
instance_group_count (pulumi.Input[str]) – The number of groups. Valid values: [2,4,8,16,32]
security_ip_lists (pulumi.Input[list]) – List of IP addresses allowed to access all databases of an instance. 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]).
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vswitch_id (pulumi.Input[str]) – The virtual switch ID to launch DB instances in one VPC.

description: pulumi.Output[str] = None¶: The name of DB instance. It a string of 2 to 256 characters.

engine: pulumi.Output[str] = None¶: Database engine: gpdb. System Default value: gpdb.

engine_version: pulumi.Output[str] = None¶: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

instance_charge_type: pulumi.Output[str] = None¶: Valid values are PrePaid, PostPaid,System default to PostPaid.

instance_class: pulumi.Output[str] = None¶: Instance specification. see Instance specifications.

instance_group_count: pulumi.Output[str] = None¶: The number of groups. Valid values: [2,4,8,16,32]

security_ip_lists: pulumi.Output[list] = None¶: List of IP addresses allowed to access all databases of an instance. 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]).

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

vswitch_id: pulumi.Output[str] = None¶: The virtual switch ID to launch DB instances in one VPC.

static get(resource_name, id, opts=None, availability_zone=None, description=None, engine=None, engine_version=None, instance_charge_type=None, instance_class=None, instance_group_count=None, security_ip_lists=None, tags=None, vswitch_id=None)¶

Get an existing Instance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The name of DB instance. It a string of 2 to 256 characters.
engine (pulumi.Input[str]) – Database engine: gpdb. System Default value: gpdb.
engine_version (pulumi.Input[str]) –
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
instance_charge_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid,System default to PostPaid.
instance_class (pulumi.Input[str]) –
Instance specification. see Instance specifications.
instance_group_count (pulumi.Input[str]) – The number of groups. Valid values: [2,4,8,16,32]
security_ip_lists (pulumi.Input[list]) – List of IP addresses allowed to access all databases of an instance. 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]).
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vswitch_id (pulumi.Input[str]) – The virtual switch ID to launch DB instances in one VPC.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_alicloud.gpdb.get_instances(availability_zone=None, ids=None, name_regex=None, output_file=None, tags=None, vswitch_id=None, opts=None)¶

The gpdb.getInstances data source provides a collection of AnalyticDB for PostgreSQL instances available in Alicloud account. Filters support regular expression for the instance name or availability_zone.

NOTE: Available in 1.47.0+

import pulumi
import pulumi_alicloud as alicloud

gpdb = alicloud.gpdb.get_instances(availability_zone="cn-beijing-c",
    name_regex="gp-.+\d+",
    output_file="instances.txt")
pulumi.export("instanceId", gpdb.instances[0]["id"])

Parameters

availability_zone (str) – Instance availability zone.
ids (list) – A list of instance IDs.
name_regex (str) – A regex string to apply to the instance name.
tags (dict) – A mapping of tags to assign to the resource.
vswitch_id (str) – Used to retrieve instances belong to specified vswitch resources.

pulumi_alicloud.gpdb.get_zones(multi=None, output_file=None, opts=None)¶

This data source provides availability zones for Gpdb that can be accessed by an Alibaba Cloud account within the region configured in the provider.

NOTE: Available in v1.73.0+.

import pulumi
import pulumi_alicloud as alicloud

zones_ids = alicloud.gpdb.get_zones()
# Create an Gpdb instance with the first matched zone
hbase = alicloud.hbase.Instance("hbase", availability_zone=zones_ids.zones[0]["id"])
# Other properties...

Parameters: multi (bool) – Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch Gpdb instances.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

gpdb¶

On This Page