Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. CloudGatewayNetwork
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.CloudGatewayNetwork

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

CloudGatewayNetwork Resource

Example Usage

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

const myCloudgatewaynetwork = new konnect.CloudGatewayNetwork("myCloudgatewaynetwork", {
    availabilityZones: ["..."],
    cidrBlock: "10.0.0.0/8",
    cloudGatewayProviderAccountId: "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
    region: "us-east-2",
});
Copy
import pulumi
import pulumi_konnect as konnect

my_cloudgatewaynetwork = konnect.CloudGatewayNetwork("myCloudgatewaynetwork",
    availability_zones=["..."],
    cidr_block="10.0.0.0/8",
    cloud_gateway_provider_account_id="929b2449-c69f-44c4-b6ad-9ecec6f811ae",
    region="us-east-2")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v2/konnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewCloudGatewayNetwork(ctx, "myCloudgatewaynetwork", &konnect.CloudGatewayNetworkArgs{
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("..."),
			},
			CidrBlock:                     pulumi.String("10.0.0.0/8"),
			CloudGatewayProviderAccountId: pulumi.String("929b2449-c69f-44c4-b6ad-9ecec6f811ae"),
			Region:                        pulumi.String("us-east-2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myCloudgatewaynetwork = new Konnect.CloudGatewayNetwork("myCloudgatewaynetwork", new()
    {
        AvailabilityZones = new[]
        {
            "...",
        },
        CidrBlock = "10.0.0.0/8",
        CloudGatewayProviderAccountId = "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
        Region = "us-east-2",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.CloudGatewayNetwork;
import com.pulumi.konnect.CloudGatewayNetworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myCloudgatewaynetwork = new CloudGatewayNetwork("myCloudgatewaynetwork", CloudGatewayNetworkArgs.builder()
            .availabilityZones("...")
            .cidrBlock("10.0.0.0/8")
            .cloudGatewayProviderAccountId("929b2449-c69f-44c4-b6ad-9ecec6f811ae")
            .region("us-east-2")
            .build());

    }
}
Copy
resources:
  myCloudgatewaynetwork:
    type: konnect:CloudGatewayNetwork
    properties:
      availabilityZones:
        - '...'
      cidrBlock: 10.0.0.0/8
      cloudGatewayProviderAccountId: 929b2449-c69f-44c4-b6ad-9ecec6f811ae
      region: us-east-2
Copy

Create CloudGatewayNetwork Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CloudGatewayNetwork(name: string, args: CloudGatewayNetworkArgs, opts?: CustomResourceOptions);
@overload
def CloudGatewayNetwork(resource_name: str,
                        args: CloudGatewayNetworkArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def CloudGatewayNetwork(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        availability_zones: Optional[Sequence[str]] = None,
                        cidr_block: Optional[str] = None,
                        cloud_gateway_provider_account_id: Optional[str] = None,
                        region: Optional[str] = None,
                        name: Optional[str] = None)
func NewCloudGatewayNetwork(ctx *Context, name string, args CloudGatewayNetworkArgs, opts ...ResourceOption) (*CloudGatewayNetwork, error)
public CloudGatewayNetwork(string name, CloudGatewayNetworkArgs args, CustomResourceOptions? opts = null)
public CloudGatewayNetwork(String name, CloudGatewayNetworkArgs args)
public CloudGatewayNetwork(String name, CloudGatewayNetworkArgs args, CustomResourceOptions options)

type: konnect:CloudGatewayNetwork
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CloudGatewayNetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CloudGatewayNetworkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CloudGatewayNetworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CloudGatewayNetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CloudGatewayNetworkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var cloudGatewayNetworkResource = new Konnect.CloudGatewayNetwork("cloudGatewayNetworkResource", new()
{
    AvailabilityZones = new[]
    {
        "string",
    },
    CidrBlock = "string",
    CloudGatewayProviderAccountId = "string",
    Region = "string",
    Name = "string",
});
Copy
example, err := konnect.NewCloudGatewayNetwork(ctx, "cloudGatewayNetworkResource", &konnect.CloudGatewayNetworkArgs{
AvailabilityZones: pulumi.StringArray{
pulumi.String("string"),
},
CidrBlock: pulumi.String("string"),
CloudGatewayProviderAccountId: pulumi.String("string"),
Region: pulumi.String("string"),
Name: pulumi.String("string"),
})
Copy
var cloudGatewayNetworkResource = new CloudGatewayNetwork("cloudGatewayNetworkResource", CloudGatewayNetworkArgs.builder()
    .availabilityZones("string")
    .cidrBlock("string")
    .cloudGatewayProviderAccountId("string")
    .region("string")
    .name("string")
    .build());
Copy
cloud_gateway_network_resource = konnect.CloudGatewayNetwork("cloudGatewayNetworkResource",
    availability_zones=["string"],
    cidr_block="string",
    cloud_gateway_provider_account_id="string",
    region="string",
    name="string")
Copy
const cloudGatewayNetworkResource = new konnect.CloudGatewayNetwork("cloudGatewayNetworkResource", {
    availabilityZones: ["string"],
    cidrBlock: "string",
    cloudGatewayProviderAccountId: "string",
    region: "string",
    name: "string",
});
Copy
type: konnect:CloudGatewayNetwork
properties:
    availabilityZones:
        - string
    cidrBlock: string
    cloudGatewayProviderAccountId: string
    name: string
    region: string
Copy

CloudGatewayNetwork Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CloudGatewayNetwork resource accepts the following input properties:

AvailabilityZones This property is required. List<string>
List of availability zones that the network is attached to. Requires replacement if changed.
CidrBlock This property is required. string
CIDR block configuration for the network. Requires replacement if changed.
CloudGatewayProviderAccountId This property is required. string
Requires replacement if changed.
Region This property is required. string
Region ID for cloud provider region. Requires replacement if changed.
Name string
Human-readable name of the network.
AvailabilityZones This property is required. []string
List of availability zones that the network is attached to. Requires replacement if changed.
CidrBlock This property is required. string
CIDR block configuration for the network. Requires replacement if changed.
CloudGatewayProviderAccountId This property is required. string
Requires replacement if changed.
Region This property is required. string
Region ID for cloud provider region. Requires replacement if changed.
Name string
Human-readable name of the network.
availabilityZones This property is required. List<String>
List of availability zones that the network is attached to. Requires replacement if changed.
cidrBlock This property is required. String
CIDR block configuration for the network. Requires replacement if changed.
cloudGatewayProviderAccountId This property is required. String
Requires replacement if changed.
region This property is required. String
Region ID for cloud provider region. Requires replacement if changed.
name String
Human-readable name of the network.
availabilityZones This property is required. string[]
List of availability zones that the network is attached to. Requires replacement if changed.
cidrBlock This property is required. string
CIDR block configuration for the network. Requires replacement if changed.
cloudGatewayProviderAccountId This property is required. string
Requires replacement if changed.
region This property is required. string
Region ID for cloud provider region. Requires replacement if changed.
name string
Human-readable name of the network.
availability_zones This property is required. Sequence[str]
List of availability zones that the network is attached to. Requires replacement if changed.
cidr_block This property is required. str
CIDR block configuration for the network. Requires replacement if changed.
cloud_gateway_provider_account_id This property is required. str
Requires replacement if changed.
region This property is required. str
Region ID for cloud provider region. Requires replacement if changed.
name str
Human-readable name of the network.
availabilityZones This property is required. List<String>
List of availability zones that the network is attached to. Requires replacement if changed.
cidrBlock This property is required. String
CIDR block configuration for the network. Requires replacement if changed.
cloudGatewayProviderAccountId This property is required. String
Requires replacement if changed.
region This property is required. String
Region ID for cloud provider region. Requires replacement if changed.
name String
Human-readable name of the network.

Outputs

All input properties are implicitly available as output properties. Additionally, the CloudGatewayNetwork resource produces the following output properties:

ConfigurationReferenceCount double
The number of configurations that reference this network.
CreatedAt string
An RFC-3339 timestamp representation of network creation date.
Default bool
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
EntityVersion double
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
Id string
The provider-assigned unique ID for this managed resource.
ProviderMetadata CloudGatewayNetworkProviderMetadata
Metadata describing attributes returned by cloud-provider for the network.
TransitGatewayCount double
The number of transit gateways attached to this network.
UpdatedAt string
An RFC-3339 timestamp representation of network update date.
ConfigurationReferenceCount float64
The number of configurations that reference this network.
CreatedAt string
An RFC-3339 timestamp representation of network creation date.
Default bool
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
EntityVersion float64
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
Id string
The provider-assigned unique ID for this managed resource.
ProviderMetadata CloudGatewayNetworkProviderMetadata
Metadata describing attributes returned by cloud-provider for the network.
TransitGatewayCount float64
The number of transit gateways attached to this network.
UpdatedAt string
An RFC-3339 timestamp representation of network update date.
configurationReferenceCount Double
The number of configurations that reference this network.
createdAt String
An RFC-3339 timestamp representation of network creation date.
default_ Boolean
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
entityVersion Double
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
id String
The provider-assigned unique ID for this managed resource.
providerMetadata CloudGatewayNetworkProviderMetadata
Metadata describing attributes returned by cloud-provider for the network.
transitGatewayCount Double
The number of transit gateways attached to this network.
updatedAt String
An RFC-3339 timestamp representation of network update date.
configurationReferenceCount number
The number of configurations that reference this network.
createdAt string
An RFC-3339 timestamp representation of network creation date.
default boolean
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
entityVersion number
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
id string
The provider-assigned unique ID for this managed resource.
providerMetadata CloudGatewayNetworkProviderMetadata
Metadata describing attributes returned by cloud-provider for the network.
transitGatewayCount number
The number of transit gateways attached to this network.
updatedAt string
An RFC-3339 timestamp representation of network update date.
configuration_reference_count float
The number of configurations that reference this network.
created_at str
An RFC-3339 timestamp representation of network creation date.
default bool
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
entity_version float
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
id str
The provider-assigned unique ID for this managed resource.
provider_metadata CloudGatewayNetworkProviderMetadata
Metadata describing attributes returned by cloud-provider for the network.
transit_gateway_count float
The number of transit gateways attached to this network.
updated_at str
An RFC-3339 timestamp representation of network update date.
configurationReferenceCount Number
The number of configurations that reference this network.
createdAt String
An RFC-3339 timestamp representation of network creation date.
default Boolean
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
entityVersion Number
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
id String
The provider-assigned unique ID for this managed resource.
providerMetadata Property Map
Metadata describing attributes returned by cloud-provider for the network.
transitGatewayCount Number
The number of transit gateways attached to this network.
updatedAt String
An RFC-3339 timestamp representation of network update date.

Look up Existing CloudGatewayNetwork Resource

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

public static get(name: string, id: Input<ID>, state?: CloudGatewayNetworkState, opts?: CustomResourceOptions): CloudGatewayNetwork
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_zones: Optional[Sequence[str]] = None,
        cidr_block: Optional[str] = None,
        cloud_gateway_provider_account_id: Optional[str] = None,
        configuration_reference_count: Optional[float] = None,
        created_at: Optional[str] = None,
        default: Optional[bool] = None,
        entity_version: Optional[float] = None,
        name: Optional[str] = None,
        provider_metadata: Optional[CloudGatewayNetworkProviderMetadataArgs] = None,
        region: Optional[str] = None,
        transit_gateway_count: Optional[float] = None,
        updated_at: Optional[str] = None) -> CloudGatewayNetwork
func GetCloudGatewayNetwork(ctx *Context, name string, id IDInput, state *CloudGatewayNetworkState, opts ...ResourceOption) (*CloudGatewayNetwork, error)
public static CloudGatewayNetwork Get(string name, Input<string> id, CloudGatewayNetworkState? state, CustomResourceOptions? opts = null)
public static CloudGatewayNetwork get(String name, Output<String> id, CloudGatewayNetworkState state, CustomResourceOptions options)
resources:  _:    type: konnect:CloudGatewayNetwork    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AvailabilityZones List<string>
List of availability zones that the network is attached to. Requires replacement if changed.
CidrBlock string
CIDR block configuration for the network. Requires replacement if changed.
CloudGatewayProviderAccountId string
Requires replacement if changed.
ConfigurationReferenceCount double
The number of configurations that reference this network.
CreatedAt string
An RFC-3339 timestamp representation of network creation date.
Default bool
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
EntityVersion double
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
Name string
Human-readable name of the network.
ProviderMetadata CloudGatewayNetworkProviderMetadata
Metadata describing attributes returned by cloud-provider for the network.
Region string
Region ID for cloud provider region. Requires replacement if changed.
TransitGatewayCount double
The number of transit gateways attached to this network.
UpdatedAt string
An RFC-3339 timestamp representation of network update date.
AvailabilityZones []string
List of availability zones that the network is attached to. Requires replacement if changed.
CidrBlock string
CIDR block configuration for the network. Requires replacement if changed.
CloudGatewayProviderAccountId string
Requires replacement if changed.
ConfigurationReferenceCount float64
The number of configurations that reference this network.
CreatedAt string
An RFC-3339 timestamp representation of network creation date.
Default bool
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
EntityVersion float64
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
Name string
Human-readable name of the network.
ProviderMetadata CloudGatewayNetworkProviderMetadataArgs
Metadata describing attributes returned by cloud-provider for the network.
Region string
Region ID for cloud provider region. Requires replacement if changed.
TransitGatewayCount float64
The number of transit gateways attached to this network.
UpdatedAt string
An RFC-3339 timestamp representation of network update date.
availabilityZones List<String>
List of availability zones that the network is attached to. Requires replacement if changed.
cidrBlock String
CIDR block configuration for the network. Requires replacement if changed.
cloudGatewayProviderAccountId String
Requires replacement if changed.
configurationReferenceCount Double
The number of configurations that reference this network.
createdAt String
An RFC-3339 timestamp representation of network creation date.
default_ Boolean
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
entityVersion Double
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
name String
Human-readable name of the network.
providerMetadata CloudGatewayNetworkProviderMetadata
Metadata describing attributes returned by cloud-provider for the network.
region String
Region ID for cloud provider region. Requires replacement if changed.
transitGatewayCount Double
The number of transit gateways attached to this network.
updatedAt String
An RFC-3339 timestamp representation of network update date.
availabilityZones string[]
List of availability zones that the network is attached to. Requires replacement if changed.
cidrBlock string
CIDR block configuration for the network. Requires replacement if changed.
cloudGatewayProviderAccountId string
Requires replacement if changed.
configurationReferenceCount number
The number of configurations that reference this network.
createdAt string
An RFC-3339 timestamp representation of network creation date.
default boolean
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
entityVersion number
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
name string
Human-readable name of the network.
providerMetadata CloudGatewayNetworkProviderMetadata
Metadata describing attributes returned by cloud-provider for the network.
region string
Region ID for cloud provider region. Requires replacement if changed.
transitGatewayCount number
The number of transit gateways attached to this network.
updatedAt string
An RFC-3339 timestamp representation of network update date.
availability_zones Sequence[str]
List of availability zones that the network is attached to. Requires replacement if changed.
cidr_block str
CIDR block configuration for the network. Requires replacement if changed.
cloud_gateway_provider_account_id str
Requires replacement if changed.
configuration_reference_count float
The number of configurations that reference this network.
created_at str
An RFC-3339 timestamp representation of network creation date.
default bool
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
entity_version float
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
name str
Human-readable name of the network.
provider_metadata CloudGatewayNetworkProviderMetadataArgs
Metadata describing attributes returned by cloud-provider for the network.
region str
Region ID for cloud provider region. Requires replacement if changed.
transit_gateway_count float
The number of transit gateways attached to this network.
updated_at str
An RFC-3339 timestamp representation of network update date.
availabilityZones List<String>
List of availability zones that the network is attached to. Requires replacement if changed.
cidrBlock String
CIDR block configuration for the network. Requires replacement if changed.
cloudGatewayProviderAccountId String
Requires replacement if changed.
configurationReferenceCount Number
The number of configurations that reference this network.
createdAt String
An RFC-3339 timestamp representation of network creation date.
default Boolean
Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
entityVersion Number
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
name String
Human-readable name of the network.
providerMetadata Property Map
Metadata describing attributes returned by cloud-provider for the network.
region String
Region ID for cloud provider region. Requires replacement if changed.
transitGatewayCount Number
The number of transit gateways attached to this network.
updatedAt String
An RFC-3339 timestamp representation of network update date.

Supporting Types

CloudGatewayNetworkProviderMetadata
, CloudGatewayNetworkProviderMetadataArgs

SubnetIds List<string>
VpcId string
SubnetIds []string
VpcId string
subnetIds List<String>
vpcId String
subnetIds string[]
vpcId string
subnet_ids Sequence[str]
vpc_id str
subnetIds List<String>
vpcId String

Import

$ pulumi import konnect:index/cloudGatewayNetwork:CloudGatewayNetwork my_konnect_cloud_gateway_network "36ae63d3-efd1-4bec-b246-62aa5d3f5695"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect