opentelekomcloud.ApigwGroupV2
Explore with Pulumi AI
Up-to-date reference of API arguments for API Gateway group service you can get at documentation portal
API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps you build, manage, and deploy APIs at any scale. With just a few clicks, you can integrate internal systems, and selectively expose capabilities with minimal costs and risks.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const group = new opentelekomcloud.ApigwGroupV2("group", {
instanceId: _var.gateway_id,
description: "test description",
environments: [{
variables: [{
name: "test-name",
value: "test-value",
}],
environmentId: _var.env_id,
}],
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
group = opentelekomcloud.ApigwGroupV2("group",
instance_id=var["gateway_id"],
description="test description",
environments=[{
"variables": [{
"name": "test-name",
"value": "test-value",
}],
"environment_id": var["env_id"],
}])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := opentelekomcloud.NewApigwGroupV2(ctx, "group", &opentelekomcloud.ApigwGroupV2Args{
InstanceId: pulumi.Any(_var.Gateway_id),
Description: pulumi.String("test description"),
Environments: opentelekomcloud.ApigwGroupV2EnvironmentArray{
&opentelekomcloud.ApigwGroupV2EnvironmentArgs{
Variables: opentelekomcloud.ApigwGroupV2EnvironmentVariableArray{
&opentelekomcloud.ApigwGroupV2EnvironmentVariableArgs{
Name: pulumi.String("test-name"),
Value: pulumi.String("test-value"),
},
},
EnvironmentId: pulumi.Any(_var.Env_id),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var @group = new Opentelekomcloud.ApigwGroupV2("group", new()
{
InstanceId = @var.Gateway_id,
Description = "test description",
Environments = new[]
{
new Opentelekomcloud.Inputs.ApigwGroupV2EnvironmentArgs
{
Variables = new[]
{
new Opentelekomcloud.Inputs.ApigwGroupV2EnvironmentVariableArgs
{
Name = "test-name",
Value = "test-value",
},
},
EnvironmentId = @var.Env_id,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.ApigwGroupV2;
import com.pulumi.opentelekomcloud.ApigwGroupV2Args;
import com.pulumi.opentelekomcloud.inputs.ApigwGroupV2EnvironmentArgs;
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 group = new ApigwGroupV2("group", ApigwGroupV2Args.builder()
.instanceId(var_.gateway_id())
.description("test description")
.environments(ApigwGroupV2EnvironmentArgs.builder()
.variables(ApigwGroupV2EnvironmentVariableArgs.builder()
.name("test-name")
.value("test-value")
.build())
.environmentId(var_.env_id())
.build())
.build());
}
}
resources:
group:
type: opentelekomcloud:ApigwGroupV2
properties:
instanceId: ${var.gateway_id}
description: test description
environments:
- variables:
- name: test-name
value: test-value
environmentId: ${var.env_id}
Create ApigwGroupV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApigwGroupV2(name: string, args: ApigwGroupV2Args, opts?: CustomResourceOptions);
@overload
def ApigwGroupV2(resource_name: str,
args: ApigwGroupV2Args,
opts: Optional[ResourceOptions] = None)
@overload
def ApigwGroupV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
apigw_group_v2_id: Optional[str] = None,
description: Optional[str] = None,
environments: Optional[Sequence[ApigwGroupV2EnvironmentArgs]] = None,
name: Optional[str] = None,
region: Optional[str] = None)
func NewApigwGroupV2(ctx *Context, name string, args ApigwGroupV2Args, opts ...ResourceOption) (*ApigwGroupV2, error)
public ApigwGroupV2(string name, ApigwGroupV2Args args, CustomResourceOptions? opts = null)
public ApigwGroupV2(String name, ApigwGroupV2Args args)
public ApigwGroupV2(String name, ApigwGroupV2Args args, CustomResourceOptions options)
type: opentelekomcloud:ApigwGroupV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ApigwGroupV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApigwGroupV2Args
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApigwGroupV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApigwGroupV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApigwGroupV2Args
- 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 apigwGroupV2Resource = new Opentelekomcloud.ApigwGroupV2("apigwGroupV2Resource", new()
{
InstanceId = "string",
ApigwGroupV2Id = "string",
Description = "string",
Environments = new[]
{
new Opentelekomcloud.Inputs.ApigwGroupV2EnvironmentArgs
{
EnvironmentId = "string",
Variables = new[]
{
new Opentelekomcloud.Inputs.ApigwGroupV2EnvironmentVariableArgs
{
Name = "string",
Value = "string",
Id = "string",
},
},
},
},
Name = "string",
Region = "string",
});
example, err := opentelekomcloud.NewApigwGroupV2(ctx, "apigwGroupV2Resource", &opentelekomcloud.ApigwGroupV2Args{
InstanceId: pulumi.String("string"),
ApigwGroupV2Id: pulumi.String("string"),
Description: pulumi.String("string"),
Environments: opentelekomcloud.ApigwGroupV2EnvironmentArray{
&opentelekomcloud.ApigwGroupV2EnvironmentArgs{
EnvironmentId: pulumi.String("string"),
Variables: opentelekomcloud.ApigwGroupV2EnvironmentVariableArray{
&opentelekomcloud.ApigwGroupV2EnvironmentVariableArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
Id: pulumi.String("string"),
},
},
},
},
Name: pulumi.String("string"),
Region: pulumi.String("string"),
})
var apigwGroupV2Resource = new ApigwGroupV2("apigwGroupV2Resource", ApigwGroupV2Args.builder()
.instanceId("string")
.apigwGroupV2Id("string")
.description("string")
.environments(ApigwGroupV2EnvironmentArgs.builder()
.environmentId("string")
.variables(ApigwGroupV2EnvironmentVariableArgs.builder()
.name("string")
.value("string")
.id("string")
.build())
.build())
.name("string")
.region("string")
.build());
apigw_group_v2_resource = opentelekomcloud.ApigwGroupV2("apigwGroupV2Resource",
instance_id="string",
apigw_group_v2_id="string",
description="string",
environments=[{
"environment_id": "string",
"variables": [{
"name": "string",
"value": "string",
"id": "string",
}],
}],
name="string",
region="string")
const apigwGroupV2Resource = new opentelekomcloud.ApigwGroupV2("apigwGroupV2Resource", {
instanceId: "string",
apigwGroupV2Id: "string",
description: "string",
environments: [{
environmentId: "string",
variables: [{
name: "string",
value: "string",
id: "string",
}],
}],
name: "string",
region: "string",
});
type: opentelekomcloud:ApigwGroupV2
properties:
apigwGroupV2Id: string
description: string
environments:
- environmentId: string
variables:
- id: string
name: string
value: string
instanceId: string
name: string
region: string
ApigwGroupV2 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 ApigwGroupV2 resource accepts the following input properties:
- Instance
Id string - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- Apigw
Group stringV2Id - The variable ID.
- Description string
- Specifies the group description.
- Environments
List<Apigw
Group V2Environment> - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - Name string
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - Region string
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- Instance
Id string - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- Apigw
Group stringV2Id - The variable ID.
- Description string
- Specifies the group description.
- Environments
[]Apigw
Group V2Environment Args - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - Name string
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - Region string
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- instance
Id String - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- apigw
Group StringV2Id - The variable ID.
- description String
- Specifies the group description.
- environments
List<Apigw
Group V2Environment> - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - name String
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - region String
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- instance
Id string - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- apigw
Group stringV2Id - The variable ID.
- description string
- Specifies the group description.
- environments
Apigw
Group V2Environment[] - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - name string
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - region string
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- instance_
id str - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- apigw_
group_ strv2_ id - The variable ID.
- description str
- Specifies the group description.
- environments
Sequence[Apigw
Group V2Environment Args] - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - name str
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - region str
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- instance
Id String - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- apigw
Group StringV2Id - The variable ID.
- description String
- Specifies the group description.
- environments List<Property Map>
- Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - name String
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - region String
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApigwGroupV2 resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Registration
Time string - The registration time, in RFC-3339 format.
- Updated
At string - The time when the API group was last modified, in RFC-3339 format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Registration
Time string - The registration time, in RFC-3339 format.
- Updated
At string - The time when the API group was last modified, in RFC-3339 format.
- id String
- The provider-assigned unique ID for this managed resource.
- registration
Time String - The registration time, in RFC-3339 format.
- updated
At String - The time when the API group was last modified, in RFC-3339 format.
- id string
- The provider-assigned unique ID for this managed resource.
- registration
Time string - The registration time, in RFC-3339 format.
- updated
At string - The time when the API group was last modified, in RFC-3339 format.
- id str
- The provider-assigned unique ID for this managed resource.
- registration_
time str - The registration time, in RFC-3339 format.
- updated_
at str - The time when the API group was last modified, in RFC-3339 format.
- id String
- The provider-assigned unique ID for this managed resource.
- registration
Time String - The registration time, in RFC-3339 format.
- updated
At String - The time when the API group was last modified, in RFC-3339 format.
Look up Existing ApigwGroupV2 Resource
Get an existing ApigwGroupV2 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?: ApigwGroupV2State, opts?: CustomResourceOptions): ApigwGroupV2
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
apigw_group_v2_id: Optional[str] = None,
description: Optional[str] = None,
environments: Optional[Sequence[ApigwGroupV2EnvironmentArgs]] = None,
instance_id: Optional[str] = None,
name: Optional[str] = None,
region: Optional[str] = None,
registration_time: Optional[str] = None,
updated_at: Optional[str] = None) -> ApigwGroupV2
func GetApigwGroupV2(ctx *Context, name string, id IDInput, state *ApigwGroupV2State, opts ...ResourceOption) (*ApigwGroupV2, error)
public static ApigwGroupV2 Get(string name, Input<string> id, ApigwGroupV2State? state, CustomResourceOptions? opts = null)
public static ApigwGroupV2 get(String name, Output<String> id, ApigwGroupV2State state, CustomResourceOptions options)
resources: _: type: opentelekomcloud:ApigwGroupV2 get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Apigw
Group stringV2Id - The variable ID.
- Description string
- Specifies the group description.
- Environments
List<Apigw
Group V2Environment> - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - Instance
Id string - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- Name string
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - Region string
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- Registration
Time string - The registration time, in RFC-3339 format.
- Updated
At string - The time when the API group was last modified, in RFC-3339 format.
- Apigw
Group stringV2Id - The variable ID.
- Description string
- Specifies the group description.
- Environments
[]Apigw
Group V2Environment Args - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - Instance
Id string - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- Name string
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - Region string
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- Registration
Time string - The registration time, in RFC-3339 format.
- Updated
At string - The time when the API group was last modified, in RFC-3339 format.
- apigw
Group StringV2Id - The variable ID.
- description String
- Specifies the group description.
- environments
List<Apigw
Group V2Environment> - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - instance
Id String - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- name String
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - region String
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- registration
Time String - The registration time, in RFC-3339 format.
- updated
At String - The time when the API group was last modified, in RFC-3339 format.
- apigw
Group stringV2Id - The variable ID.
- description string
- Specifies the group description.
- environments
Apigw
Group V2Environment[] - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - instance
Id string - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- name string
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - region string
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- registration
Time string - The registration time, in RFC-3339 format.
- updated
At string - The time when the API group was last modified, in RFC-3339 format.
- apigw_
group_ strv2_ id - The variable ID.
- description str
- Specifies the group description.
- environments
Sequence[Apigw
Group V2Environment Args] - Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - instance_
id str - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- name str
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - region str
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- registration_
time str - The registration time, in RFC-3339 format.
- updated_
at str - The time when the API group was last modified, in RFC-3339 format.
- apigw
Group StringV2Id - The variable ID.
- description String
- Specifies the group description.
- environments List<Property Map>
- Specifies an array of one or more environments of the associated group.
The
environment
structure is documented below. - instance
Id String - Specifies the ID of the dedicated instance to which the group belongs. Changing this will create a new resource.
- name String
- Specifies the group name.
The valid length is limited from
3
to64
, only letters, digits and hyphens (-) are allowed. - region String
- Specifies the region where the APIGW group is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
- registration
Time String - The registration time, in RFC-3339 format.
- updated
At String - The time when the API group was last modified, in RFC-3339 format.
Supporting Types
ApigwGroupV2Environment, ApigwGroupV2EnvironmentArgs
- Environment
Id string - Specifies the environment ID of the associated group.
- Variables
List<Apigw
Group V2Environment Variable> Specifies an array of one or more environment variables. The
variable
structure is documented below.The environment variables of different groups are isolated in the same environment.
- Environment
Id string - Specifies the environment ID of the associated group.
- Variables
[]Apigw
Group V2Environment Variable Specifies an array of one or more environment variables. The
variable
structure is documented below.The environment variables of different groups are isolated in the same environment.
- environment
Id String - Specifies the environment ID of the associated group.
- variables
List<Apigw
Group V2Environment Variable> Specifies an array of one or more environment variables. The
variable
structure is documented below.The environment variables of different groups are isolated in the same environment.
- environment
Id string - Specifies the environment ID of the associated group.
- variables
Apigw
Group V2Environment Variable[] Specifies an array of one or more environment variables. The
variable
structure is documented below.The environment variables of different groups are isolated in the same environment.
- environment_
id str - Specifies the environment ID of the associated group.
- variables
Sequence[Apigw
Group V2Environment Variable] Specifies an array of one or more environment variables. The
variable
structure is documented below.The environment variables of different groups are isolated in the same environment.
- environment
Id String - Specifies the environment ID of the associated group.
- variables List<Property Map>
Specifies an array of one or more environment variables. The
variable
structure is documented below.The environment variables of different groups are isolated in the same environment.
ApigwGroupV2EnvironmentVariable, ApigwGroupV2EnvironmentVariableArgs
- Name string
- Specifies the variable name.
The valid length is limited from
3
to32
characters. Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter. - Value string
- Specifies the variable value.
The valid length is limited from
1
to255
characters. Only letters, digits and special characters (_-/.:) are allowed. - Id string
- The variable ID.
- Name string
- Specifies the variable name.
The valid length is limited from
3
to32
characters. Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter. - Value string
- Specifies the variable value.
The valid length is limited from
1
to255
characters. Only letters, digits and special characters (_-/.:) are allowed. - Id string
- The variable ID.
- name String
- Specifies the variable name.
The valid length is limited from
3
to32
characters. Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter. - value String
- Specifies the variable value.
The valid length is limited from
1
to255
characters. Only letters, digits and special characters (_-/.:) are allowed. - id String
- The variable ID.
- name string
- Specifies the variable name.
The valid length is limited from
3
to32
characters. Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter. - value string
- Specifies the variable value.
The valid length is limited from
1
to255
characters. Only letters, digits and special characters (_-/.:) are allowed. - id string
- The variable ID.
- name str
- Specifies the variable name.
The valid length is limited from
3
to32
characters. Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter. - value str
- Specifies the variable value.
The valid length is limited from
1
to255
characters. Only letters, digits and special characters (_-/.:) are allowed. - id str
- The variable ID.
- name String
- Specifies the variable name.
The valid length is limited from
3
to32
characters. Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter. - value String
- Specifies the variable value.
The valid length is limited from
1
to255
characters. Only letters, digits and special characters (_-/.:) are allowed. - id String
- The variable ID.
Import
API groups can be imported using their id
and the ID of the related dedicated instance, separated by a slash, e.g.
$ pulumi import opentelekomcloud:index/apigwGroupV2:ApigwGroupV2 test <instance_id>/<id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
- License
- Notes
- This Pulumi package is based on the
opentelekomcloud
Terraform Provider.