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.

cloudconnect¶

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.cloudconnect.AwaitableGetNetworksResult(id=None, ids=None, name_regex=None, names=None, networks=None, output_file=None)¶

class pulumi_alicloud.cloudconnect.GetNetworksResult(id=None, ids=None, name_regex=None, names=None, networks=None, output_file=None)¶

A collection of values returned by getNetworks.

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

ids = None¶: A list of CCN instances IDs.

names = None¶: A list of CCN instances names.

networks = None¶: A list of CCN instances. Each element contains the following attributes:

class pulumi_alicloud.cloudconnect.Network(resource_name, opts=None, cidr_block=None, description=None, is_default=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a cloud connect network resource. Cloud Connect Network (CCN) is another important component of Smart Access Gateway. It is a device access matrix composed of Alibaba Cloud distributed access gateways. You can add multiple Smart Access Gateway (SAG) devices to a CCN instance and then attach the CCN instance to a Cloud Enterprise Network (CEN) instance to connect the local branches to the Alibaba Cloud.

For information about cloud connect network and how to use it, see What is Cloud Connect Network.

NOTE: Available in 1.59.0+
NOTE: Only the following regions support create Cloud Connect Network. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.cloudconnect.Network("default",
    cidr_block="192.168.0.0/24",
    description="tf-testAccCloudConnectNetworkDescription",
    is_default=True)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
cidr_block (pulumi.Input[str]) – The CidrBlock of the CCN instance. Defaults to null.
description (pulumi.Input[str]) – The description of the CCN instance. The description can contain 2 to 256 characters. The description must start with English letters, but cannot start with http:// or https://.
is_default (pulumi.Input[bool]) – Created by default. If the client does not have ccn in the binding, it will create a ccn for the user to replace.
name (pulumi.Input[str]) – The name of the CCN instance. The name can contain 2 to 128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. The name must start with an English letter, but cannot start with http:// or https://.

cidr_block: pulumi.Output[str] = None¶: The CidrBlock of the CCN instance. Defaults to null.

description: pulumi.Output[str] = None¶: The description of the CCN instance. The description can contain 2 to 256 characters. The description must start with English letters, but cannot start with http:// or https://.

is_default: pulumi.Output[bool] = None¶: Created by default. If the client does not have ccn in the binding, it will create a ccn for the user to replace.

name: pulumi.Output[str] = None¶: The name of the CCN instance. The name can contain 2 to 128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. The name must start with an English letter, but cannot start with http:// or https://.

static get(resource_name, id, opts=None, cidr_block=None, description=None, is_default=None, name=None)¶

Get an existing Network 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.
cidr_block (pulumi.Input[str]) – The CidrBlock of the CCN instance. Defaults to null.
description (pulumi.Input[str]) – The description of the CCN instance. The description can contain 2 to 256 characters. The description must start with English letters, but cannot start with http:// or https://.
is_default (pulumi.Input[bool]) – Created by default. If the client does not have ccn in the binding, it will create a ccn for the user to replace.
name (pulumi.Input[str]) – The name of the CCN instance. The name can contain 2 to 128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. The name must start with an English letter, but cannot start with http:// or https://.

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.cloudconnect.NetworkAttachment(resource_name, opts=None, ccn_id=None, sag_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Cloud Connect Network Attachment resource. This topic describes how to associate a Smart Access Gateway (SAG) instance with a network instance. You must associate an SAG instance with a network instance if you want to connect the SAG to Alibaba Cloud. You can connect an SAG to Alibaba Cloud through a leased line, the Internet, or the active and standby links.

For information about Cloud Connect Network Attachment and how to use it, see What is Cloud Connect Network Attachment.

NOTE: Available in 1.64.0+
NOTE: Only the following regions support. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

ccn = alicloud.cloudconnect.Network("ccn", is_default="true")
default = alicloud.cloudconnect.NetworkAttachment("default",
    ccn_id=ccn.id,
    sag_id="sag-xxxxx")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
ccn_id (pulumi.Input[str]) – The ID of the CCN instance.
sag_id (pulumi.Input[str]) – The ID of the Smart Access Gateway instance.

ccn_id: pulumi.Output[str] = None¶: The ID of the CCN instance.

sag_id: pulumi.Output[str] = None¶: The ID of the Smart Access Gateway instance.

static get(resource_name, id, opts=None, ccn_id=None, sag_id=None)¶

Get an existing NetworkAttachment 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.
ccn_id (pulumi.Input[str]) – The ID of the CCN instance.
sag_id (pulumi.Input[str]) – The ID of the Smart Access Gateway instance.

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.cloudconnect.NetworkGrant(resource_name, opts=None, ccn_id=None, cen_id=None, cen_uid=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Cloud Connect Network Grant resource. If the CEN instance to be attached belongs to another account, authorization by the CEN instance is required.

For information about Cloud Connect Network Grant and how to use it, see What is Cloud Connect Network Grant.

NOTE: Available in 1.63.0+
NOTE: Only the following regions support create Cloud Connect Network Grant. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud
import pulumi_pulumi as pulumi

ccn_account = pulumi.providers.Alicloud("ccnAccount")
cen_account = pulumi.providers.Alicloud("cenAccount",
    access_key="xxxxxx",
    region="cn-hangzhou",
    secret_key="xxxxxx")
cen = alicloud.cen.Instance("cen")
ccn = alicloud.cloudconnect.Network("ccn", is_default="true")
default = alicloud.cloudconnect.NetworkGrant("default",
    ccn_id=ccn.id,
    cen_id=cen.id,
    cen_uid="xxxxxx")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
ccn_id (pulumi.Input[str]) – The ID of the CCN instance.
cen_id (pulumi.Input[str]) – The ID of the CEN instance.
cen_uid (pulumi.Input[str]) – The ID of the account to which the CEN instance belongs.

ccn_id: pulumi.Output[str] = None¶: The ID of the CCN instance.

cen_id: pulumi.Output[str] = None¶: The ID of the CEN instance.

cen_uid: pulumi.Output[str] = None¶: The ID of the account to which the CEN instance belongs.

static get(resource_name, id, opts=None, ccn_id=None, cen_id=None, cen_uid=None)¶

Get an existing NetworkGrant 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.
ccn_id (pulumi.Input[str]) – The ID of the CCN instance.
cen_id (pulumi.Input[str]) – The ID of the CEN instance.
cen_uid (pulumi.Input[str]) – The ID of the account to which the CEN instance belongs.

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.cloudconnect.get_networks(ids=None, name_regex=None, output_file=None, opts=None)¶

This data source provides Cloud Connect Networks available to the user.

NOTE: Available in 1.59.0+
NOTE: Only the following regions support create Cloud Connect Network. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default_networks = alicloud.cloudconnect.get_networks(ids=[alicloud_cloud_connect_networks["default"]["id"]],
    name_regex="^tf-testAcc.*")
default_network = alicloud.cloudconnect.Network("defaultNetwork",
    cidr_block="192.168.0.0/24",
    description="tf-testAccCloudConnectNetworkDescription",
    is_default=True)

Parameters

ids (list) – A list of CCN instances IDs.
name_regex (str) – A regex string to filter CCN instances by name.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

cloudconnect¶

On This Page