1. Docs
  2. Reference
  3. API
  4. @pulumi/alicloud
  5. cloudconnect

Module cloudconnect

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

Resources

Functions

Others

Resources

Resource Network

class Network extends CustomResource

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]

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const defaultNetwork = new alicloud.cloudconnect.Network("default", {
    cidrBlock: "192.168.0.0/24",
    description: "tf-testAccCloudConnectNetworkDescription",
    isDefault: true,
});

constructor

new Network(name: string, args: NetworkArgs, opts?: pulumi.CustomResourceOptions)

Create a Network resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkState, opts?: pulumi.CustomResourceOptions): Network

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Network

Returns true if the given object is an instance of Network. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cidrBlock

public cidrBlock: pulumi.Output<string | undefined>;

The CidrBlock of the CCN instance. Defaults to null.

property description

public description: pulumi.Output<string | undefined>;

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://.

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 isDefault

public isDefault: pulumi.Output<boolean>;

Created by default. If the client does not have ccn in the binding, it will create a ccn for the user to replace.

property name

public name: pulumi.Output<string>;

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://.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkAttachment

class NetworkAttachment extends CustomResource

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]

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const ccn = new alicloud.cloudconnect.Network("ccn", {
    isDefault: true,
});
const defaultNetworkAttachment = new alicloud.cloudconnect.NetworkAttachment("default", {
    ccnId: ccn.id,
    sagId: "sag-xxxxx",
}, { dependsOn: [ccn] });

constructor

new NetworkAttachment(name: string, args: NetworkAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkAttachmentState, opts?: pulumi.CustomResourceOptions): NetworkAttachment

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkAttachment

Returns true if the given object is an instance of NetworkAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property ccnId

public ccnId: pulumi.Output<string>;

The ID of the CCN instance.

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 sagId

public sagId: pulumi.Output<string>;

The ID of the Smart Access Gateway instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkGrant

class NetworkGrant extends CustomResource

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]

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const ccnAccount = new alicloud.Provider("ccnAccount", {});
const cenAccount = new alicloud.Provider("cenAccount", {
    accessKey: "xxxxxx",
    region: "cn-hangzhou",
    secretKey: "xxxxxx",
});
const cen = new alicloud.cen.Instance("cen", {}, { provider: cenAccount });
const ccn = new alicloud.cloudconnect.Network("ccn", {
    isDefault: true,
}, { provider: ccnAccount });
const defaultNetworkGrant = new alicloud.cloudconnect.NetworkGrant("default", {
    ccnId: ccn.id,
    cenId: cen.id,
    cenUid: "xxxxxx",
}, { dependsOn: [cen, ccn] });

constructor

new NetworkGrant(name: string, args: NetworkGrantArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkGrant resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkGrantState, opts?: pulumi.CustomResourceOptions): NetworkGrant

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkGrant

Returns true if the given object is an instance of NetworkGrant. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property ccnId

public ccnId: pulumi.Output<string>;

The ID of the CCN instance.

property cenId

public cenId: pulumi.Output<string>;

The ID of the CEN instance.

property cenUid

public cenUid: pulumi.Output<string>;

The ID of the account to which the CEN instance belongs.

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 urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getNetworks

getNetworks(args?: GetNetworksArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworksResult>

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]

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const defaultNetworks = alicloud_cloud_connect_networks_default.id.apply(id => alicloud.cloudconnect.getNetworks({
    ids: [id],
    nameRegex: "^tf-testAcc.*",
}, { async: true }));
const defaultNetwork = new alicloud.cloudconnect.Network("default", {
    cidrBlock: "192.168.0.0/24",
    description: "tf-testAccCloudConnectNetworkDescription",
    isDefault: true,
});

Others

interface GetNetworksArgs

interface GetNetworksArgs

A collection of arguments for invoking getNetworks.

property ids

ids?: string[];

A list of CCN instances IDs.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter CCN instances by name.

property outputFile

outputFile?: undefined | string;

interface GetNetworksResult

interface GetNetworksResult

A collection of values returned by getNetworks.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of CCN instances IDs.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of CCN instances names.

property networks

networks: GetNetworksNetwork[];

A list of CCN instances. Each element contains the following attributes:

property outputFile

outputFile?: undefined | string;

interface NetworkArgs

interface NetworkArgs

The set of arguments for constructing a Network resource.

property cidrBlock

cidrBlock?: pulumi.Input<string>;

The CidrBlock of the CCN instance. Defaults to null.

property description

description?: pulumi.Input<string>;

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://.

property isDefault

isDefault: pulumi.Input<boolean>;

Created by default. If the client does not have ccn in the binding, it will create a ccn for the user to replace.

property name

name?: pulumi.Input<string>;

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://.

interface NetworkAttachmentArgs

interface NetworkAttachmentArgs

The set of arguments for constructing a NetworkAttachment resource.

property ccnId

ccnId: pulumi.Input<string>;

The ID of the CCN instance.

property sagId

sagId: pulumi.Input<string>;

The ID of the Smart Access Gateway instance.

interface NetworkAttachmentState

interface NetworkAttachmentState

Input properties used for looking up and filtering NetworkAttachment resources.

property ccnId

ccnId?: pulumi.Input<string>;

The ID of the CCN instance.

property sagId

sagId?: pulumi.Input<string>;

The ID of the Smart Access Gateway instance.

interface NetworkGrantArgs

interface NetworkGrantArgs

The set of arguments for constructing a NetworkGrant resource.

property ccnId

ccnId: pulumi.Input<string>;

The ID of the CCN instance.

property cenId

cenId: pulumi.Input<string>;

The ID of the CEN instance.

property cenUid

cenUid: pulumi.Input<string>;

The ID of the account to which the CEN instance belongs.

interface NetworkGrantState

interface NetworkGrantState

Input properties used for looking up and filtering NetworkGrant resources.

property ccnId

ccnId?: pulumi.Input<string>;

The ID of the CCN instance.

property cenId

cenId?: pulumi.Input<string>;

The ID of the CEN instance.

property cenUid

cenUid?: pulumi.Input<string>;

The ID of the account to which the CEN instance belongs.

interface NetworkState

interface NetworkState

Input properties used for looking up and filtering Network resources.

property cidrBlock

cidrBlock?: pulumi.Input<string>;

The CidrBlock of the CCN instance. Defaults to null.

property description

description?: pulumi.Input<string>;

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://.

property isDefault

isDefault?: pulumi.Input<boolean>;

Created by default. If the client does not have ccn in the binding, it will create a ccn for the user to replace.

property name

name?: pulumi.Input<string>;

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://.