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

konnect.CloudGatewayConfiguration

Explore with Pulumi AI

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

CloudGatewayConfiguration Resource

Example Usage

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

const myCloudgatewayconfiguration = new konnect.CloudGatewayConfiguration("myCloudgatewayconfiguration", {
    apiAccess: "public",
    controlPlaneGeo: "us",
    controlPlaneId: "0949471e-b759-45ba-87ab-ee63fb781388",
    dataplaneGroups: [{
        autoscale: {
            configurationDataPlaneGroupAutoscaleStatic: {
                instanceType: "medium",
                kind: "static",
                requestedInstances: 3,
            },
        },
        cloudGatewayNetworkId: "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
        environments: [{
            name: "KONG_LOG_LEVEL",
            value: "INFO",
        }],
        provider: "aws",
        region: "us-east-2",
    }],
    version: "3.2",
});
Copy
import pulumi
import pulumi_konnect as konnect

my_cloudgatewayconfiguration = konnect.CloudGatewayConfiguration("myCloudgatewayconfiguration",
    api_access="public",
    control_plane_geo="us",
    control_plane_id="0949471e-b759-45ba-87ab-ee63fb781388",
    dataplane_groups=[{
        "autoscale": {
            "configuration_data_plane_group_autoscale_static": {
                "instance_type": "medium",
                "kind": "static",
                "requested_instances": 3,
            },
        },
        "cloud_gateway_network_id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
        "environments": [{
            "name": "KONG_LOG_LEVEL",
            "value": "INFO",
        }],
        "provider": "aws",
        "region": "us-east-2",
    }],
    version="3.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.NewCloudGatewayConfiguration(ctx, "myCloudgatewayconfiguration", &konnect.CloudGatewayConfigurationArgs{
			ApiAccess:       pulumi.String("public"),
			ControlPlaneGeo: pulumi.String("us"),
			ControlPlaneId:  pulumi.String("0949471e-b759-45ba-87ab-ee63fb781388"),
			DataplaneGroups: konnect.CloudGatewayConfigurationDataplaneGroupArray{
				&konnect.CloudGatewayConfigurationDataplaneGroupArgs{
					Autoscale: &konnect.CloudGatewayConfigurationDataplaneGroupAutoscaleArgs{
						ConfigurationDataPlaneGroupAutoscaleStatic: &konnect.CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleStaticArgs{
							InstanceType:       pulumi.String("medium"),
							Kind:               pulumi.String("static"),
							RequestedInstances: pulumi.Float64(3),
						},
					},
					CloudGatewayNetworkId: pulumi.String("36ae63d3-efd1-4bec-b246-62aa5d3f5695"),
					Environments: konnect.CloudGatewayConfigurationDataplaneGroupEnvironmentArray{
						&konnect.CloudGatewayConfigurationDataplaneGroupEnvironmentArgs{
							Name:  pulumi.String("KONG_LOG_LEVEL"),
							Value: pulumi.String("INFO"),
						},
					},
					Provider: pulumi.String("aws"),
					Region:   pulumi.String("us-east-2"),
				},
			},
			Version: pulumi.String("3.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 myCloudgatewayconfiguration = new Konnect.CloudGatewayConfiguration("myCloudgatewayconfiguration", new()
    {
        ApiAccess = "public",
        ControlPlaneGeo = "us",
        ControlPlaneId = "0949471e-b759-45ba-87ab-ee63fb781388",
        DataplaneGroups = new[]
        {
            new Konnect.Inputs.CloudGatewayConfigurationDataplaneGroupArgs
            {
                Autoscale = new Konnect.Inputs.CloudGatewayConfigurationDataplaneGroupAutoscaleArgs
                {
                    ConfigurationDataPlaneGroupAutoscaleStatic = new Konnect.Inputs.CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleStaticArgs
                    {
                        InstanceType = "medium",
                        Kind = "static",
                        RequestedInstances = 3,
                    },
                },
                CloudGatewayNetworkId = "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
                Environments = new[]
                {
                    new Konnect.Inputs.CloudGatewayConfigurationDataplaneGroupEnvironmentArgs
                    {
                        Name = "KONG_LOG_LEVEL",
                        Value = "INFO",
                    },
                },
                Provider = "aws",
                Region = "us-east-2",
            },
        },
        Version = "3.2",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.CloudGatewayConfiguration;
import com.pulumi.konnect.CloudGatewayConfigurationArgs;
import com.pulumi.konnect.inputs.CloudGatewayConfigurationDataplaneGroupArgs;
import com.pulumi.konnect.inputs.CloudGatewayConfigurationDataplaneGroupAutoscaleArgs;
import com.pulumi.konnect.inputs.CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleStaticArgs;
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 myCloudgatewayconfiguration = new CloudGatewayConfiguration("myCloudgatewayconfiguration", CloudGatewayConfigurationArgs.builder()
            .apiAccess("public")
            .controlPlaneGeo("us")
            .controlPlaneId("0949471e-b759-45ba-87ab-ee63fb781388")
            .dataplaneGroups(CloudGatewayConfigurationDataplaneGroupArgs.builder()
                .autoscale(CloudGatewayConfigurationDataplaneGroupAutoscaleArgs.builder()
                    .configurationDataPlaneGroupAutoscaleStatic(CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleStaticArgs.builder()
                        .instanceType("medium")
                        .kind("static")
                        .requestedInstances(3)
                        .build())
                    .build())
                .cloudGatewayNetworkId("36ae63d3-efd1-4bec-b246-62aa5d3f5695")
                .environments(CloudGatewayConfigurationDataplaneGroupEnvironmentArgs.builder()
                    .name("KONG_LOG_LEVEL")
                    .value("INFO")
                    .build())
                .provider("aws")
                .region("us-east-2")
                .build())
            .version("3.2")
            .build());

    }
}
Copy
resources:
  myCloudgatewayconfiguration:
    type: konnect:CloudGatewayConfiguration
    properties:
      apiAccess: public
      controlPlaneGeo: us
      controlPlaneId: 0949471e-b759-45ba-87ab-ee63fb781388
      dataplaneGroups:
        - autoscale:
            configurationDataPlaneGroupAutoscaleStatic:
              instanceType: medium
              kind: static
              requestedInstances: 3
          cloudGatewayNetworkId: 36ae63d3-efd1-4bec-b246-62aa5d3f5695
          environments:
            - name: KONG_LOG_LEVEL
              value: INFO
          provider: aws
          region: us-east-2
      version: '3.2'
Copy

Create CloudGatewayConfiguration Resource

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

Constructor syntax

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

@overload
def CloudGatewayConfiguration(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              control_plane_geo: Optional[str] = None,
                              control_plane_id: Optional[str] = None,
                              dataplane_groups: Optional[Sequence[CloudGatewayConfigurationDataplaneGroupArgs]] = None,
                              version: Optional[str] = None,
                              api_access: Optional[str] = None)
func NewCloudGatewayConfiguration(ctx *Context, name string, args CloudGatewayConfigurationArgs, opts ...ResourceOption) (*CloudGatewayConfiguration, error)
public CloudGatewayConfiguration(string name, CloudGatewayConfigurationArgs args, CustomResourceOptions? opts = null)
public CloudGatewayConfiguration(String name, CloudGatewayConfigurationArgs args)
public CloudGatewayConfiguration(String name, CloudGatewayConfigurationArgs args, CustomResourceOptions options)

type: konnect:CloudGatewayConfiguration
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. CloudGatewayConfigurationArgs
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. CloudGatewayConfigurationArgs
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. CloudGatewayConfigurationArgs
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. CloudGatewayConfigurationArgs
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. CloudGatewayConfigurationArgs
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 cloudGatewayConfigurationResource = new Konnect.CloudGatewayConfiguration("cloudGatewayConfigurationResource", new()
{
    ControlPlaneGeo = "string",
    ControlPlaneId = "string",
    DataplaneGroups = new[]
    {
        new Konnect.Inputs.CloudGatewayConfigurationDataplaneGroupArgs
        {
            Autoscale = new Konnect.Inputs.CloudGatewayConfigurationDataplaneGroupAutoscaleArgs
            {
                ConfigurationDataPlaneGroupAutoscaleAutopilot = new Konnect.Inputs.CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleAutopilotArgs
                {
                    BaseRps = 0,
                    Kind = "string",
                    MaxRps = 0,
                },
                ConfigurationDataPlaneGroupAutoscaleStatic = new Konnect.Inputs.CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleStaticArgs
                {
                    InstanceType = "string",
                    Kind = "string",
                    RequestedInstances = 0,
                },
            },
            CloudGatewayNetworkId = "string",
            CreatedAt = "string",
            EgressIpAddresses = new[]
            {
                "string",
            },
            Environments = new[]
            {
                new Konnect.Inputs.CloudGatewayConfigurationDataplaneGroupEnvironmentArgs
                {
                    Name = "string",
                    Value = "string",
                },
            },
            Id = "string",
            PrivateIpAddresses = new[]
            {
                "string",
            },
            Provider = "string",
            Region = "string",
            State = "string",
            UpdatedAt = "string",
        },
    },
    Version = "string",
    ApiAccess = "string",
});
Copy
example, err := konnect.NewCloudGatewayConfiguration(ctx, "cloudGatewayConfigurationResource", &konnect.CloudGatewayConfigurationArgs{
ControlPlaneGeo: pulumi.String("string"),
ControlPlaneId: pulumi.String("string"),
DataplaneGroups: .CloudGatewayConfigurationDataplaneGroupArray{
&.CloudGatewayConfigurationDataplaneGroupArgs{
Autoscale: &.CloudGatewayConfigurationDataplaneGroupAutoscaleArgs{
ConfigurationDataPlaneGroupAutoscaleAutopilot: &.CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleAutopilotArgs{
BaseRps: pulumi.Float64(0),
Kind: pulumi.String("string"),
MaxRps: pulumi.Float64(0),
},
ConfigurationDataPlaneGroupAutoscaleStatic: &.CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleStaticArgs{
InstanceType: pulumi.String("string"),
Kind: pulumi.String("string"),
RequestedInstances: pulumi.Float64(0),
},
},
CloudGatewayNetworkId: pulumi.String("string"),
CreatedAt: pulumi.String("string"),
EgressIpAddresses: pulumi.StringArray{
pulumi.String("string"),
},
Environments: .CloudGatewayConfigurationDataplaneGroupEnvironmentArray{
&.CloudGatewayConfigurationDataplaneGroupEnvironmentArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Id: pulumi.String("string"),
PrivateIpAddresses: pulumi.StringArray{
pulumi.String("string"),
},
Provider: pulumi.String("string"),
Region: pulumi.String("string"),
State: pulumi.String("string"),
UpdatedAt: pulumi.String("string"),
},
},
Version: pulumi.String("string"),
ApiAccess: pulumi.String("string"),
})
Copy
var cloudGatewayConfigurationResource = new CloudGatewayConfiguration("cloudGatewayConfigurationResource", CloudGatewayConfigurationArgs.builder()
    .controlPlaneGeo("string")
    .controlPlaneId("string")
    .dataplaneGroups(CloudGatewayConfigurationDataplaneGroupArgs.builder()
        .autoscale(CloudGatewayConfigurationDataplaneGroupAutoscaleArgs.builder()
            .configurationDataPlaneGroupAutoscaleAutopilot(CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleAutopilotArgs.builder()
                .baseRps(0)
                .kind("string")
                .maxRps(0)
                .build())
            .configurationDataPlaneGroupAutoscaleStatic(CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleStaticArgs.builder()
                .instanceType("string")
                .kind("string")
                .requestedInstances(0)
                .build())
            .build())
        .cloudGatewayNetworkId("string")
        .createdAt("string")
        .egressIpAddresses("string")
        .environments(CloudGatewayConfigurationDataplaneGroupEnvironmentArgs.builder()
            .name("string")
            .value("string")
            .build())
        .id("string")
        .privateIpAddresses("string")
        .provider("string")
        .region("string")
        .state("string")
        .updatedAt("string")
        .build())
    .version("string")
    .apiAccess("string")
    .build());
Copy
cloud_gateway_configuration_resource = konnect.CloudGatewayConfiguration("cloudGatewayConfigurationResource",
    control_plane_geo="string",
    control_plane_id="string",
    dataplane_groups=[{
        "autoscale": {
            "configuration_data_plane_group_autoscale_autopilot": {
                "base_rps": 0,
                "kind": "string",
                "max_rps": 0,
            },
            "configuration_data_plane_group_autoscale_static": {
                "instance_type": "string",
                "kind": "string",
                "requested_instances": 0,
            },
        },
        "cloud_gateway_network_id": "string",
        "created_at": "string",
        "egress_ip_addresses": ["string"],
        "environments": [{
            "name": "string",
            "value": "string",
        }],
        "id": "string",
        "private_ip_addresses": ["string"],
        "provider": "string",
        "region": "string",
        "state": "string",
        "updated_at": "string",
    }],
    version="string",
    api_access="string")
Copy
const cloudGatewayConfigurationResource = new konnect.CloudGatewayConfiguration("cloudGatewayConfigurationResource", {
    controlPlaneGeo: "string",
    controlPlaneId: "string",
    dataplaneGroups: [{
        autoscale: {
            configurationDataPlaneGroupAutoscaleAutopilot: {
                baseRps: 0,
                kind: "string",
                maxRps: 0,
            },
            configurationDataPlaneGroupAutoscaleStatic: {
                instanceType: "string",
                kind: "string",
                requestedInstances: 0,
            },
        },
        cloudGatewayNetworkId: "string",
        createdAt: "string",
        egressIpAddresses: ["string"],
        environments: [{
            name: "string",
            value: "string",
        }],
        id: "string",
        privateIpAddresses: ["string"],
        provider: "string",
        region: "string",
        state: "string",
        updatedAt: "string",
    }],
    version: "string",
    apiAccess: "string",
});
Copy
type: konnect:CloudGatewayConfiguration
properties:
    apiAccess: string
    controlPlaneGeo: string
    controlPlaneId: string
    dataplaneGroups:
        - autoscale:
            configurationDataPlaneGroupAutoscaleAutopilot:
                baseRps: 0
                kind: string
                maxRps: 0
            configurationDataPlaneGroupAutoscaleStatic:
                instanceType: string
                kind: string
                requestedInstances: 0
          cloudGatewayNetworkId: string
          createdAt: string
          egressIpAddresses:
            - string
          environments:
            - name: string
              value: string
          id: string
          privateIpAddresses:
            - string
          provider: string
          region: string
          state: string
          updatedAt: string
    version: string
Copy

CloudGatewayConfiguration 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 CloudGatewayConfiguration resource accepts the following input properties:

ControlPlaneGeo This property is required. string
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
ControlPlaneId This property is required. string
DataplaneGroups This property is required. List<CloudGatewayConfigurationDataplaneGroup>
List of data-plane groups that describe where to deploy instances, along with how many instances.
Version This property is required. string
Supported gateway version.
ApiAccess string
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
ControlPlaneGeo This property is required. string
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
ControlPlaneId This property is required. string
DataplaneGroups This property is required. []CloudGatewayConfigurationDataplaneGroupArgs
List of data-plane groups that describe where to deploy instances, along with how many instances.
Version This property is required. string
Supported gateway version.
ApiAccess string
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
controlPlaneGeo This property is required. String
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
controlPlaneId This property is required. String
dataplaneGroups This property is required. List<CloudGatewayConfigurationDataplaneGroup>
List of data-plane groups that describe where to deploy instances, along with how many instances.
version This property is required. String
Supported gateway version.
apiAccess String
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
controlPlaneGeo This property is required. string
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
controlPlaneId This property is required. string
dataplaneGroups This property is required. CloudGatewayConfigurationDataplaneGroup[]
List of data-plane groups that describe where to deploy instances, along with how many instances.
version This property is required. string
Supported gateway version.
apiAccess string
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
control_plane_geo This property is required. str
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
control_plane_id This property is required. str
dataplane_groups This property is required. Sequence[CloudGatewayConfigurationDataplaneGroupArgs]
List of data-plane groups that describe where to deploy instances, along with how many instances.
version This property is required. str
Supported gateway version.
api_access str
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
controlPlaneGeo This property is required. String
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
controlPlaneId This property is required. String
dataplaneGroups This property is required. List<Property Map>
List of data-plane groups that describe where to deploy instances, along with how many instances.
version This property is required. String
Supported gateway version.
apiAccess String
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]

Outputs

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

CreatedAt string
An RFC-3339 timestamp representation of configuration creation date.
DataplaneGroupConfigs List<CloudGatewayConfigurationDataplaneGroupConfig>
Object that describes where data-planes will be deployed to, along with how many instances.
EntityVersion double
Positive, monotonically increasing version integer, to serialize configuration changes.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
An RFC-3339 timestamp representation of configuration update date.
CreatedAt string
An RFC-3339 timestamp representation of configuration creation date.
DataplaneGroupConfigs []CloudGatewayConfigurationDataplaneGroupConfig
Object that describes where data-planes will be deployed to, along with how many instances.
EntityVersion float64
Positive, monotonically increasing version integer, to serialize configuration changes.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
An RFC-3339 timestamp representation of configuration update date.
createdAt String
An RFC-3339 timestamp representation of configuration creation date.
dataplaneGroupConfigs List<CloudGatewayConfigurationDataplaneGroupConfig>
Object that describes where data-planes will be deployed to, along with how many instances.
entityVersion Double
Positive, monotonically increasing version integer, to serialize configuration changes.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
An RFC-3339 timestamp representation of configuration update date.
createdAt string
An RFC-3339 timestamp representation of configuration creation date.
dataplaneGroupConfigs CloudGatewayConfigurationDataplaneGroupConfig[]
Object that describes where data-planes will be deployed to, along with how many instances.
entityVersion number
Positive, monotonically increasing version integer, to serialize configuration changes.
id string
The provider-assigned unique ID for this managed resource.
updatedAt string
An RFC-3339 timestamp representation of configuration update date.
created_at str
An RFC-3339 timestamp representation of configuration creation date.
dataplane_group_configs Sequence[CloudGatewayConfigurationDataplaneGroupConfig]
Object that describes where data-planes will be deployed to, along with how many instances.
entity_version float
Positive, monotonically increasing version integer, to serialize configuration changes.
id str
The provider-assigned unique ID for this managed resource.
updated_at str
An RFC-3339 timestamp representation of configuration update date.
createdAt String
An RFC-3339 timestamp representation of configuration creation date.
dataplaneGroupConfigs List<Property Map>
Object that describes where data-planes will be deployed to, along with how many instances.
entityVersion Number
Positive, monotonically increasing version integer, to serialize configuration changes.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
An RFC-3339 timestamp representation of configuration update date.

Look up Existing CloudGatewayConfiguration Resource

Get an existing CloudGatewayConfiguration 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?: CloudGatewayConfigurationState, opts?: CustomResourceOptions): CloudGatewayConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_access: Optional[str] = None,
        control_plane_geo: Optional[str] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[str] = None,
        dataplane_group_configs: Optional[Sequence[CloudGatewayConfigurationDataplaneGroupConfigArgs]] = None,
        dataplane_groups: Optional[Sequence[CloudGatewayConfigurationDataplaneGroupArgs]] = None,
        entity_version: Optional[float] = None,
        updated_at: Optional[str] = None,
        version: Optional[str] = None) -> CloudGatewayConfiguration
func GetCloudGatewayConfiguration(ctx *Context, name string, id IDInput, state *CloudGatewayConfigurationState, opts ...ResourceOption) (*CloudGatewayConfiguration, error)
public static CloudGatewayConfiguration Get(string name, Input<string> id, CloudGatewayConfigurationState? state, CustomResourceOptions? opts = null)
public static CloudGatewayConfiguration get(String name, Output<String> id, CloudGatewayConfigurationState state, CustomResourceOptions options)
resources:  _:    type: konnect:CloudGatewayConfiguration    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:
ApiAccess string
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
ControlPlaneGeo string
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
ControlPlaneId string
CreatedAt string
An RFC-3339 timestamp representation of configuration creation date.
DataplaneGroupConfigs List<CloudGatewayConfigurationDataplaneGroupConfig>
Object that describes where data-planes will be deployed to, along with how many instances.
DataplaneGroups List<CloudGatewayConfigurationDataplaneGroup>
List of data-plane groups that describe where to deploy instances, along with how many instances.
EntityVersion double
Positive, monotonically increasing version integer, to serialize configuration changes.
UpdatedAt string
An RFC-3339 timestamp representation of configuration update date.
Version string
Supported gateway version.
ApiAccess string
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
ControlPlaneGeo string
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
ControlPlaneId string
CreatedAt string
An RFC-3339 timestamp representation of configuration creation date.
DataplaneGroupConfigs []CloudGatewayConfigurationDataplaneGroupConfigArgs
Object that describes where data-planes will be deployed to, along with how many instances.
DataplaneGroups []CloudGatewayConfigurationDataplaneGroupArgs
List of data-plane groups that describe where to deploy instances, along with how many instances.
EntityVersion float64
Positive, monotonically increasing version integer, to serialize configuration changes.
UpdatedAt string
An RFC-3339 timestamp representation of configuration update date.
Version string
Supported gateway version.
apiAccess String
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
controlPlaneGeo String
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
controlPlaneId String
createdAt String
An RFC-3339 timestamp representation of configuration creation date.
dataplaneGroupConfigs List<CloudGatewayConfigurationDataplaneGroupConfig>
Object that describes where data-planes will be deployed to, along with how many instances.
dataplaneGroups List<CloudGatewayConfigurationDataplaneGroup>
List of data-plane groups that describe where to deploy instances, along with how many instances.
entityVersion Double
Positive, monotonically increasing version integer, to serialize configuration changes.
updatedAt String
An RFC-3339 timestamp representation of configuration update date.
version String
Supported gateway version.
apiAccess string
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
controlPlaneGeo string
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
controlPlaneId string
createdAt string
An RFC-3339 timestamp representation of configuration creation date.
dataplaneGroupConfigs CloudGatewayConfigurationDataplaneGroupConfig[]
Object that describes where data-planes will be deployed to, along with how many instances.
dataplaneGroups CloudGatewayConfigurationDataplaneGroup[]
List of data-plane groups that describe where to deploy instances, along with how many instances.
entityVersion number
Positive, monotonically increasing version integer, to serialize configuration changes.
updatedAt string
An RFC-3339 timestamp representation of configuration update date.
version string
Supported gateway version.
api_access str
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
control_plane_geo str
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
control_plane_id str
created_at str
An RFC-3339 timestamp representation of configuration creation date.
dataplane_group_configs Sequence[CloudGatewayConfigurationDataplaneGroupConfigArgs]
Object that describes where data-planes will be deployed to, along with how many instances.
dataplane_groups Sequence[CloudGatewayConfigurationDataplaneGroupArgs]
List of data-plane groups that describe where to deploy instances, along with how many instances.
entity_version float
Positive, monotonically increasing version integer, to serialize configuration changes.
updated_at str
An RFC-3339 timestamp representation of configuration update date.
version str
Supported gateway version.
apiAccess String
Type of API access data-plane groups will support for a configuration. Default: "private+public"; must be one of ["private", "public", "private+public"]
controlPlaneGeo String
Set of control-plane geos supported for deploying cloud-gateways configurations. must be one of ["us", "eu", "au", "me", "in"]
controlPlaneId String
createdAt String
An RFC-3339 timestamp representation of configuration creation date.
dataplaneGroupConfigs List<Property Map>
Object that describes where data-planes will be deployed to, along with how many instances.
dataplaneGroups List<Property Map>
List of data-plane groups that describe where to deploy instances, along with how many instances.
entityVersion Number
Positive, monotonically increasing version integer, to serialize configuration changes.
updatedAt String
An RFC-3339 timestamp representation of configuration update date.
version String
Supported gateway version.

Supporting Types

CloudGatewayConfigurationDataplaneGroup
, CloudGatewayConfigurationDataplaneGroupArgs

Autoscale CloudGatewayConfigurationDataplaneGroupAutoscale
Not Null
CloudGatewayNetworkId string
Not Null
CreatedAt string
An RFC-3339 timestamp representation of data-plane group creation date.
EgressIpAddresses List<string>
List of egress IP addresses for the network that this data-plane group runs on.
Environments List<CloudGatewayConfigurationDataplaneGroupEnvironment>
Array of environment variables to set for a data-plane group.
Id string
ID of the data-plane group that represents a deployment target for a set of data-planes.
PrivateIpAddresses List<string>
List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.
Provider string
Name of cloud provider. Not Null; must be one of ["aws", "azure"]
Region string
Region ID for cloud provider region. Not Null
State string
State of the data-plane group. must be one of ["created", "initializing", "ready", "terminating", "terminated"]
UpdatedAt string
An RFC-3339 timestamp representation of data-plane group update date.
Autoscale CloudGatewayConfigurationDataplaneGroupAutoscale
Not Null
CloudGatewayNetworkId string
Not Null
CreatedAt string
An RFC-3339 timestamp representation of data-plane group creation date.
EgressIpAddresses []string
List of egress IP addresses for the network that this data-plane group runs on.
Environments []CloudGatewayConfigurationDataplaneGroupEnvironment
Array of environment variables to set for a data-plane group.
Id string
ID of the data-plane group that represents a deployment target for a set of data-planes.
PrivateIpAddresses []string
List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.
Provider string
Name of cloud provider. Not Null; must be one of ["aws", "azure"]
Region string
Region ID for cloud provider region. Not Null
State string
State of the data-plane group. must be one of ["created", "initializing", "ready", "terminating", "terminated"]
UpdatedAt string
An RFC-3339 timestamp representation of data-plane group update date.
autoscale CloudGatewayConfigurationDataplaneGroupAutoscale
Not Null
cloudGatewayNetworkId String
Not Null
createdAt String
An RFC-3339 timestamp representation of data-plane group creation date.
egressIpAddresses List<String>
List of egress IP addresses for the network that this data-plane group runs on.
environments List<CloudGatewayConfigurationDataplaneGroupEnvironment>
Array of environment variables to set for a data-plane group.
id String
ID of the data-plane group that represents a deployment target for a set of data-planes.
privateIpAddresses List<String>
List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.
provider String
Name of cloud provider. Not Null; must be one of ["aws", "azure"]
region String
Region ID for cloud provider region. Not Null
state String
State of the data-plane group. must be one of ["created", "initializing", "ready", "terminating", "terminated"]
updatedAt String
An RFC-3339 timestamp representation of data-plane group update date.
autoscale CloudGatewayConfigurationDataplaneGroupAutoscale
Not Null
cloudGatewayNetworkId string
Not Null
createdAt string
An RFC-3339 timestamp representation of data-plane group creation date.
egressIpAddresses string[]
List of egress IP addresses for the network that this data-plane group runs on.
environments CloudGatewayConfigurationDataplaneGroupEnvironment[]
Array of environment variables to set for a data-plane group.
id string
ID of the data-plane group that represents a deployment target for a set of data-planes.
privateIpAddresses string[]
List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.
provider string
Name of cloud provider. Not Null; must be one of ["aws", "azure"]
region string
Region ID for cloud provider region. Not Null
state string
State of the data-plane group. must be one of ["created", "initializing", "ready", "terminating", "terminated"]
updatedAt string
An RFC-3339 timestamp representation of data-plane group update date.
autoscale CloudGatewayConfigurationDataplaneGroupAutoscale
Not Null
cloud_gateway_network_id str
Not Null
created_at str
An RFC-3339 timestamp representation of data-plane group creation date.
egress_ip_addresses Sequence[str]
List of egress IP addresses for the network that this data-plane group runs on.
environments Sequence[CloudGatewayConfigurationDataplaneGroupEnvironment]
Array of environment variables to set for a data-plane group.
id str
ID of the data-plane group that represents a deployment target for a set of data-planes.
private_ip_addresses Sequence[str]
List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.
provider str
Name of cloud provider. Not Null; must be one of ["aws", "azure"]
region str
Region ID for cloud provider region. Not Null
state str
State of the data-plane group. must be one of ["created", "initializing", "ready", "terminating", "terminated"]
updated_at str
An RFC-3339 timestamp representation of data-plane group update date.
autoscale Property Map
Not Null
cloudGatewayNetworkId String
Not Null
createdAt String
An RFC-3339 timestamp representation of data-plane group creation date.
egressIpAddresses List<String>
List of egress IP addresses for the network that this data-plane group runs on.
environments List<Property Map>
Array of environment variables to set for a data-plane group.
id String
ID of the data-plane group that represents a deployment target for a set of data-planes.
privateIpAddresses List<String>
List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.
provider String
Name of cloud provider. Not Null; must be one of ["aws", "azure"]
region String
Region ID for cloud provider region. Not Null
state String
State of the data-plane group. must be one of ["created", "initializing", "ready", "terminating", "terminated"]
updatedAt String
An RFC-3339 timestamp representation of data-plane group update date.

CloudGatewayConfigurationDataplaneGroupAutoscale
, CloudGatewayConfigurationDataplaneGroupAutoscaleArgs

configurationDataPlaneGroupAutoscaleAutopilot Property Map
Object that describes the autopilot autoscaling strategy.
configurationDataPlaneGroupAutoscaleStatic Property Map
Object that describes the static autoscaling strategy.

CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleAutopilot
, CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleAutopilotArgs

BaseRps double
Base number of requests per second that the deployment target should support. Not Null
Kind string
Not Null; must be "autopilot"
MaxRps double
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
BaseRps float64
Base number of requests per second that the deployment target should support. Not Null
Kind string
Not Null; must be "autopilot"
MaxRps float64
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
baseRps Double
Base number of requests per second that the deployment target should support. Not Null
kind String
Not Null; must be "autopilot"
maxRps Double
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
baseRps number
Base number of requests per second that the deployment target should support. Not Null
kind string
Not Null; must be "autopilot"
maxRps number
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
base_rps float
Base number of requests per second that the deployment target should support. Not Null
kind str
Not Null; must be "autopilot"
max_rps float
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
baseRps Number
Base number of requests per second that the deployment target should support. Not Null
kind String
Not Null; must be "autopilot"
maxRps Number
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.

CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleStatic
, CloudGatewayConfigurationDataplaneGroupAutoscaleConfigurationDataPlaneGroupAutoscaleStaticArgs

InstanceType string
Instance type name to indicate capacity. Not Null; must be one of ["small", "medium", "large"]
Kind string
Not Null; must be "static"
RequestedInstances double
Number of data-planes the deployment target will contain. Not Null
InstanceType string
Instance type name to indicate capacity. Not Null; must be one of ["small", "medium", "large"]
Kind string
Not Null; must be "static"
RequestedInstances float64
Number of data-planes the deployment target will contain. Not Null
instanceType String
Instance type name to indicate capacity. Not Null; must be one of ["small", "medium", "large"]
kind String
Not Null; must be "static"
requestedInstances Double
Number of data-planes the deployment target will contain. Not Null
instanceType string
Instance type name to indicate capacity. Not Null; must be one of ["small", "medium", "large"]
kind string
Not Null; must be "static"
requestedInstances number
Number of data-planes the deployment target will contain. Not Null
instance_type str
Instance type name to indicate capacity. Not Null; must be one of ["small", "medium", "large"]
kind str
Not Null; must be "static"
requested_instances float
Number of data-planes the deployment target will contain. Not Null
instanceType String
Instance type name to indicate capacity. Not Null; must be one of ["small", "medium", "large"]
kind String
Not Null; must be "static"
requestedInstances Number
Number of data-planes the deployment target will contain. Not Null

CloudGatewayConfigurationDataplaneGroupConfig
, CloudGatewayConfigurationDataplaneGroupConfigArgs

Autoscale CloudGatewayConfigurationDataplaneGroupConfigAutoscale
CloudGatewayNetworkId string
Environments List<CloudGatewayConfigurationDataplaneGroupConfigEnvironment>
Array of environment variables to set for a data-plane group.
Provider string
Name of cloud provider. must be one of ["aws", "azure"]
Region string
Region ID for cloud provider region.
Autoscale CloudGatewayConfigurationDataplaneGroupConfigAutoscale
CloudGatewayNetworkId string
Environments []CloudGatewayConfigurationDataplaneGroupConfigEnvironment
Array of environment variables to set for a data-plane group.
Provider string
Name of cloud provider. must be one of ["aws", "azure"]
Region string
Region ID for cloud provider region.
autoscale CloudGatewayConfigurationDataplaneGroupConfigAutoscale
cloudGatewayNetworkId String
environments List<CloudGatewayConfigurationDataplaneGroupConfigEnvironment>
Array of environment variables to set for a data-plane group.
provider String
Name of cloud provider. must be one of ["aws", "azure"]
region String
Region ID for cloud provider region.
autoscale CloudGatewayConfigurationDataplaneGroupConfigAutoscale
cloudGatewayNetworkId string
environments CloudGatewayConfigurationDataplaneGroupConfigEnvironment[]
Array of environment variables to set for a data-plane group.
provider string
Name of cloud provider. must be one of ["aws", "azure"]
region string
Region ID for cloud provider region.
autoscale CloudGatewayConfigurationDataplaneGroupConfigAutoscale
cloud_gateway_network_id str
environments Sequence[CloudGatewayConfigurationDataplaneGroupConfigEnvironment]
Array of environment variables to set for a data-plane group.
provider str
Name of cloud provider. must be one of ["aws", "azure"]
region str
Region ID for cloud provider region.
autoscale Property Map
cloudGatewayNetworkId String
environments List<Property Map>
Array of environment variables to set for a data-plane group.
provider String
Name of cloud provider. must be one of ["aws", "azure"]
region String
Region ID for cloud provider region.

CloudGatewayConfigurationDataplaneGroupConfigAutoscale
, CloudGatewayConfigurationDataplaneGroupConfigAutoscaleArgs

configurationDataPlaneGroupAutoscaleAutopilot Property Map
Object that describes the autopilot autoscaling strategy.
configurationDataPlaneGroupAutoscaleStatic Property Map
Object that describes the static autoscaling strategy.

CloudGatewayConfigurationDataplaneGroupConfigAutoscaleConfigurationDataPlaneGroupAutoscaleAutopilot
, CloudGatewayConfigurationDataplaneGroupConfigAutoscaleConfigurationDataPlaneGroupAutoscaleAutopilotArgs

BaseRps double
Base number of requests per second that the deployment target should support.
Kind string
must be "autopilot"
MaxRps double
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
BaseRps float64
Base number of requests per second that the deployment target should support.
Kind string
must be "autopilot"
MaxRps float64
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
baseRps Double
Base number of requests per second that the deployment target should support.
kind String
must be "autopilot"
maxRps Double
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
baseRps number
Base number of requests per second that the deployment target should support.
kind string
must be "autopilot"
maxRps number
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
base_rps float
Base number of requests per second that the deployment target should support.
kind str
must be "autopilot"
max_rps float
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
baseRps Number
Base number of requests per second that the deployment target should support.
kind String
must be "autopilot"
maxRps Number
Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.

CloudGatewayConfigurationDataplaneGroupConfigAutoscaleConfigurationDataPlaneGroupAutoscaleStatic
, CloudGatewayConfigurationDataplaneGroupConfigAutoscaleConfigurationDataPlaneGroupAutoscaleStaticArgs

InstanceType string
Instance type name to indicate capacity. must be one of ["small", "medium", "large"]
Kind string
must be "static"
RequestedInstances double
Number of data-planes the deployment target will contain.
InstanceType string
Instance type name to indicate capacity. must be one of ["small", "medium", "large"]
Kind string
must be "static"
RequestedInstances float64
Number of data-planes the deployment target will contain.
instanceType String
Instance type name to indicate capacity. must be one of ["small", "medium", "large"]
kind String
must be "static"
requestedInstances Double
Number of data-planes the deployment target will contain.
instanceType string
Instance type name to indicate capacity. must be one of ["small", "medium", "large"]
kind string
must be "static"
requestedInstances number
Number of data-planes the deployment target will contain.
instance_type str
Instance type name to indicate capacity. must be one of ["small", "medium", "large"]
kind str
must be "static"
requested_instances float
Number of data-planes the deployment target will contain.
instanceType String
Instance type name to indicate capacity. must be one of ["small", "medium", "large"]
kind String
must be "static"
requestedInstances Number
Number of data-planes the deployment target will contain.

CloudGatewayConfigurationDataplaneGroupConfigEnvironment
, CloudGatewayConfigurationDataplaneGroupConfigEnvironmentArgs

Name string
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.
Value string
Value assigned to the environment variable field for the data-plane group.
Name string
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.
Value string
Value assigned to the environment variable field for the data-plane group.
name String
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.
value String
Value assigned to the environment variable field for the data-plane group.
name string
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.
value string
Value assigned to the environment variable field for the data-plane group.
name str
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.
value str
Value assigned to the environment variable field for the data-plane group.
name String
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.
value String
Value assigned to the environment variable field for the data-plane group.

CloudGatewayConfigurationDataplaneGroupEnvironment
, CloudGatewayConfigurationDataplaneGroupEnvironmentArgs

Name string
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_. Not Null
Value string
Value assigned to the environment variable field for the data-plane group. Not Null
Name string
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_. Not Null
Value string
Value assigned to the environment variable field for the data-plane group. Not Null
name String
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_. Not Null
value String
Value assigned to the environment variable field for the data-plane group. Not Null
name string
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_. Not Null
value string
Value assigned to the environment variable field for the data-plane group. Not Null
name str
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_. Not Null
value str
Value assigned to the environment variable field for the data-plane group. Not Null
name String
Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_. Not Null
value String
Value assigned to the environment variable field for the data-plane group. Not Null

Import

$ pulumi import konnect:index/cloudGatewayConfiguration:CloudGatewayConfiguration my_konnect_cloud_gateway_configuration "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471"
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