Alibaba Cloud v3.73.0, Jan 15 25

Alibaba Cloud v3.73.0 published on Wednesday, Jan 15, 2025 by Pulumi

alicloud.apig.Environment

Explore with Pulumi AI

Alibaba Cloud v3.73.0 published on Wednesday, Jan 15, 2025 by Pulumi

Create Environment Resource

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

Constructor syntax

new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);

@overload
def Environment(resource_name: str,
                args: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                environment_name: Optional[str] = None,
                gateway_id: Optional[str] = None,
                description: Optional[str] = None,
                resource_group_id: Optional[str] = None)

func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)

public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)

public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

type: alicloud:apig:Environment
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 EnvironmentArgs: 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 EnvironmentArgs: 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 EnvironmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EnvironmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EnvironmentArgs: 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 environmentResource = new AliCloud.Apig.Environment("environmentResource", new()
{
    EnvironmentName = "string",
    GatewayId = "string",
    Description = "string",
    ResourceGroupId = "string",
});

example, err := apig.NewEnvironment(ctx, "environmentResource", &apig.EnvironmentArgs{
	EnvironmentName: pulumi.String("string"),
	GatewayId:       pulumi.String("string"),
	Description:     pulumi.String("string"),
	ResourceGroupId: pulumi.String("string"),
})

var environmentResource = new Environment("environmentResource", EnvironmentArgs.builder()
    .environmentName("string")
    .gatewayId("string")
    .description("string")
    .resourceGroupId("string")
    .build());

environment_resource = alicloud.apig.Environment("environmentResource",
    environment_name="string",
    gateway_id="string",
    description="string",
    resource_group_id="string")

const environmentResource = new alicloud.apig.Environment("environmentResource", {
    environmentName: "string",
    gatewayId: "string",
    description: "string",
    resourceGroupId: "string",
});

type: alicloud:apig:Environment
properties:
    description: string
    environmentName: string
    gatewayId: string
    resourceGroupId: string

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

EnvironmentName string: The name of the resource
GatewayId string: Gateway id
Description string: Description
ResourceGroupId string: The ID of the resource group

EnvironmentName string: The name of the resource
GatewayId string: Gateway id
Description string: Description
ResourceGroupId string: The ID of the resource group

environmentName String: The name of the resource
gatewayId String: Gateway id
description String: Description
resourceGroupId String: The ID of the resource group

environmentName string: The name of the resource
gatewayId string: Gateway id
description string: Description
resourceGroupId string: The ID of the resource group

environment_name str: The name of the resource
gateway_id str: Gateway id
description str: Description
resource_group_id str: The ID of the resource group

environmentName String: The name of the resource
gatewayId String: Gateway id
description String: Description
resourceGroupId String: The ID of the resource group

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Environment Resource

Get an existing Environment 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?: EnvironmentState, opts?: CustomResourceOptions): Environment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        environment_name: Optional[str] = None,
        gateway_id: Optional[str] = None,
        resource_group_id: Optional[str] = None) -> Environment

func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)

public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)

public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)

resources:  _:    type: alicloud:apig:Environment    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.

The following state arguments are supported:

Description string: Description
EnvironmentName string: The name of the resource
GatewayId string: Gateway id
ResourceGroupId string: The ID of the resource group

Description string: Description
EnvironmentName string: The name of the resource
GatewayId string: Gateway id
ResourceGroupId string: The ID of the resource group

description String: Description
environmentName String: The name of the resource
gatewayId String: Gateway id
resourceGroupId String: The ID of the resource group

description string: Description
environmentName string: The name of the resource
gatewayId string: Gateway id
resourceGroupId string: The ID of the resource group

description str: Description
environment_name str: The name of the resource
gateway_id str: Gateway id
resource_group_id str: The ID of the resource group

description String: Description
environmentName String: The name of the resource
gatewayId String: Gateway id
resourceGroupId String: The ID of the resource group

Import

APIG Environment can be imported using the id, e.g.

$ pulumi import alicloud:apig/environment:Environment example <id>

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

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.73.0 published on Wednesday, Jan 15, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.apig.Environment

On this page

On this page

Create Environment Resource

Constructor syntax

Parameters

Constructor example

Environment Resource Properties

Inputs

Outputs

Look up Existing Environment Resource

Import

Package Details

On this page

On this page