Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. apigateway
  5. VpcAccess
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.apigateway.VpcAccess

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

    Example Usage

    Basic Usage

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

const example = alicloud.getZones({
    availableResourceCreation: "Instance",
});
const exampleGetInstanceTypes = example.then(example => alicloud.ecs.getInstanceTypes({
    availabilityZone: example.zones?.[0]?.id,
    cpuCoreCount: 1,
    memorySize: 2,
}));
const exampleNetwork = new alicloud.vpc.Network("example", {
    vpcName: "terraform-example",
    cidrBlock: "10.4.0.0/16",
});
const exampleSwitch = new alicloud.vpc.Switch("example", {
    vswitchName: "terraform-example",
    cidrBlock: "10.4.0.0/24",
    vpcId: exampleNetwork.id,
    zoneId: example.then(example => example.zones?.[0]?.id),
});
const exampleSecurityGroup = new alicloud.ecs.SecurityGroup("example", {
    name: "terraform-example",
    description: "New security group",
    vpcId: exampleNetwork.id,
});
const exampleGetImages = alicloud.ecs.getImages({
    nameRegex: "^ubuntu_18.*64",
    owners: "system",
});
const exampleInstance = new alicloud.ecs.Instance("example", {
    availabilityZone: example.then(example => example.zones?.[0]?.id),
    instanceName: "terraform-example",
    imageId: exampleGetImages.then(exampleGetImages => exampleGetImages.images?.[0]?.id),
    instanceType: exampleGetInstanceTypes.then(exampleGetInstanceTypes => exampleGetInstanceTypes.instanceTypes?.[0]?.id),
    securityGroups: [exampleSecurityGroup.id],
    vswitchId: exampleSwitch.id,
});
const exampleVpcAccess = new alicloud.apigateway.VpcAccess("example", {
    name: "terraform-example",
    vpcId: exampleNetwork.id,
    instanceId: exampleInstance.id,
    port: 8080,
});

    import pulumi
import pulumi_alicloud as alicloud

example = alicloud.get_zones(available_resource_creation="Instance")
example_get_instance_types = alicloud.ecs.get_instance_types(availability_zone=example.zones[0].id,
    cpu_core_count=1,
    memory_size=2)
example_network = alicloud.vpc.Network("example",
    vpc_name="terraform-example",
    cidr_block="10.4.0.0/16")
example_switch = alicloud.vpc.Switch("example",
    vswitch_name="terraform-example",
    cidr_block="10.4.0.0/24",
    vpc_id=example_network.id,
    zone_id=example.zones[0].id)
example_security_group = alicloud.ecs.SecurityGroup("example",
    name="terraform-example",
    description="New security group",
    vpc_id=example_network.id)
example_get_images = alicloud.ecs.get_images(name_regex="^ubuntu_18.*64",
    owners="system")
example_instance = alicloud.ecs.Instance("example",
    availability_zone=example.zones[0].id,
    instance_name="terraform-example",
    image_id=example_get_images.images[0].id,
    instance_type=example_get_instance_types.instance_types[0].id,
    security_groups=[example_security_group.id],
    vswitch_id=example_switch.id)
example_vpc_access = alicloud.apigateway.VpcAccess("example",
    name="terraform-example",
    vpc_id=example_network.id,
    instance_id=example_instance.id,
    port=8080)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: pulumi.StringRef("Instance"),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetInstanceTypes, err := ecs.GetInstanceTypes(ctx, &ecs.GetInstanceTypesArgs{
			AvailabilityZone: pulumi.StringRef(example.Zones[0].Id),
			CpuCoreCount:     pulumi.IntRef(1),
			MemorySize:       pulumi.Float64Ref(2),
		}, nil)
		if err != nil {
			return err
		}
		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("10.4.0.0/16"),
		})
		if err != nil {
			return err
		}
		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
			VswitchName: pulumi.String("terraform-example"),
			CidrBlock:   pulumi.String("10.4.0.0/24"),
			VpcId:       exampleNetwork.ID(),
			ZoneId:      pulumi.String(example.Zones[0].Id),
		})
		if err != nil {
			return err
		}
		exampleSecurityGroup, err := ecs.NewSecurityGroup(ctx, "example", &ecs.SecurityGroupArgs{
			Name:        pulumi.String("terraform-example"),
			Description: pulumi.String("New security group"),
			VpcId:       exampleNetwork.ID(),
		})
		if err != nil {
			return err
		}
		exampleGetImages, err := ecs.GetImages(ctx, &ecs.GetImagesArgs{
			NameRegex: pulumi.StringRef("^ubuntu_18.*64"),
			Owners:    pulumi.StringRef("system"),
		}, nil)
		if err != nil {
			return err
		}
		exampleInstance, err := ecs.NewInstance(ctx, "example", &ecs.InstanceArgs{
			AvailabilityZone: pulumi.String(example.Zones[0].Id),
			InstanceName:     pulumi.String("terraform-example"),
			ImageId:          pulumi.String(exampleGetImages.Images[0].Id),
			InstanceType:     pulumi.String(exampleGetInstanceTypes.InstanceTypes[0].Id),
			SecurityGroups: pulumi.StringArray{
				exampleSecurityGroup.ID(),
			},
			VswitchId: exampleSwitch.ID(),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewVpcAccess(ctx, "example", &apigateway.VpcAccessArgs{
			Name:       pulumi.String("terraform-example"),
			VpcId:      exampleNetwork.ID(),
			InstanceId: exampleInstance.ID(),
			Port:       pulumi.Int(8080),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var example = AliCloud.GetZones.Invoke(new()
    {
        AvailableResourceCreation = "Instance",
    });

    var exampleGetInstanceTypes = AliCloud.Ecs.GetInstanceTypes.Invoke(new()
    {
        AvailabilityZone = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        CpuCoreCount = 1,
        MemorySize = 2,
    });

    var exampleNetwork = new AliCloud.Vpc.Network("example", new()
    {
        VpcName = "terraform-example",
        CidrBlock = "10.4.0.0/16",
    });

    var exampleSwitch = new AliCloud.Vpc.Switch("example", new()
    {
        VswitchName = "terraform-example",
        CidrBlock = "10.4.0.0/24",
        VpcId = exampleNetwork.Id,
        ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
    });

    var exampleSecurityGroup = new AliCloud.Ecs.SecurityGroup("example", new()
    {
        Name = "terraform-example",
        Description = "New security group",
        VpcId = exampleNetwork.Id,
    });

    var exampleGetImages = AliCloud.Ecs.GetImages.Invoke(new()
    {
        NameRegex = "^ubuntu_18.*64",
        Owners = "system",
    });

    var exampleInstance = new AliCloud.Ecs.Instance("example", new()
    {
        AvailabilityZone = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        InstanceName = "terraform-example",
        ImageId = exampleGetImages.Apply(getImagesResult => getImagesResult.Images[0]?.Id),
        InstanceType = exampleGetInstanceTypes.Apply(getInstanceTypesResult => getInstanceTypesResult.InstanceTypes[0]?.Id),
        SecurityGroups = new[]
        {
            exampleSecurityGroup.Id,
        },
        VswitchId = exampleSwitch.Id,
    });

    var exampleVpcAccess = new AliCloud.ApiGateway.VpcAccess("example", new()
    {
        Name = "terraform-example",
        VpcId = exampleNetwork.Id,
        InstanceId = exampleInstance.Id,
        Port = 8080,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.ecs.EcsFunctions;
import com.pulumi.alicloud.ecs.inputs.GetInstanceTypesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.ecs.inputs.GetImagesArgs;
import com.pulumi.alicloud.ecs.Instance;
import com.pulumi.alicloud.ecs.InstanceArgs;
import com.pulumi.alicloud.apigateway.VpcAccess;
import com.pulumi.alicloud.apigateway.VpcAccessArgs;
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) {
        final var example = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .availableResourceCreation("Instance")
            .build());

        final var exampleGetInstanceTypes = EcsFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
            .availabilityZone(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .cpuCoreCount(1)
            .memorySize(2)
            .build());

        var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
            .vpcName("terraform-example")
            .cidrBlock("10.4.0.0/16")
            .build());

        var exampleSwitch = new Switch("exampleSwitch", SwitchArgs.builder()
            .vswitchName("terraform-example")
            .cidrBlock("10.4.0.0/24")
            .vpcId(exampleNetwork.id())
            .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .build());

        var exampleSecurityGroup = new SecurityGroup("exampleSecurityGroup", SecurityGroupArgs.builder()
            .name("terraform-example")
            .description("New security group")
            .vpcId(exampleNetwork.id())
            .build());

        final var exampleGetImages = EcsFunctions.getImages(GetImagesArgs.builder()
            .nameRegex("^ubuntu_18.*64")
            .owners("system")
            .build());

        var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
            .availabilityZone(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .instanceName("terraform-example")
            .imageId(exampleGetImages.applyValue(getImagesResult -> getImagesResult.images()[0].id()))
            .instanceType(exampleGetInstanceTypes.applyValue(getInstanceTypesResult -> getInstanceTypesResult.instanceTypes()[0].id()))
            .securityGroups(exampleSecurityGroup.id())
            .vswitchId(exampleSwitch.id())
            .build());

        var exampleVpcAccess = new VpcAccess("exampleVpcAccess", VpcAccessArgs.builder()
            .name("terraform-example")
            .vpcId(exampleNetwork.id())
            .instanceId(exampleInstance.id())
            .port(8080)
            .build());

    }
}

    resources:
  exampleNetwork:
    type: alicloud:vpc:Network
    name: example
    properties:
      vpcName: terraform-example
      cidrBlock: 10.4.0.0/16
  exampleSwitch:
    type: alicloud:vpc:Switch
    name: example
    properties:
      vswitchName: terraform-example
      cidrBlock: 10.4.0.0/24
      vpcId: ${exampleNetwork.id}
      zoneId: ${example.zones[0].id}
  exampleSecurityGroup:
    type: alicloud:ecs:SecurityGroup
    name: example
    properties:
      name: terraform-example
      description: New security group
      vpcId: ${exampleNetwork.id}
  exampleInstance:
    type: alicloud:ecs:Instance
    name: example
    properties:
      availabilityZone: ${example.zones[0].id}
      instanceName: terraform-example
      imageId: ${exampleGetImages.images[0].id}
      instanceType: ${exampleGetInstanceTypes.instanceTypes[0].id}
      securityGroups:
        - ${exampleSecurityGroup.id}
      vswitchId: ${exampleSwitch.id}
  exampleVpcAccess:
    type: alicloud:apigateway:VpcAccess
    name: example
    properties:
      name: terraform-example
      vpcId: ${exampleNetwork.id}
      instanceId: ${exampleInstance.id}
      port: 8080
variables:
  example:
    fn::invoke:
      Function: alicloud:getZones
      Arguments:
        availableResourceCreation: Instance
  exampleGetInstanceTypes:
    fn::invoke:
      Function: alicloud:ecs:getInstanceTypes
      Arguments:
        availabilityZone: ${example.zones[0].id}
        cpuCoreCount: 1
        memorySize: 2
  exampleGetImages:
    fn::invoke:
      Function: alicloud:ecs:getImages
      Arguments:
        nameRegex: ^ubuntu_18.*64
        owners: system

    Create VpcAccess Resource

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

    Constructor syntax

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

@overload
def VpcAccess(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              instance_id: Optional[str] = None,
              port: Optional[int] = None,
              vpc_id: Optional[str] = None,
              name: Optional[str] = None)
    func NewVpcAccess(ctx *Context, name string, args VpcAccessArgs, opts ...ResourceOption) (*VpcAccess, error)
    public VpcAccess(string name, VpcAccessArgs args, CustomResourceOptions? opts = null)
    public VpcAccess(String name, VpcAccessArgs args)
public VpcAccess(String name, VpcAccessArgs args, CustomResourceOptions options)

    type: alicloud:apigateway:VpcAccess
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 VpcAccessArgs
    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 VpcAccessArgs
    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 VpcAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcAccessArgs
    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 vpcAccessResource = new AliCloud.ApiGateway.VpcAccess("vpcAccessResource", new()
{
    InstanceId = "string",
    Port = 0,
    VpcId = "string",
    Name = "string",
});

    example, err := apigateway.NewVpcAccess(ctx, "vpcAccessResource", &apigateway.VpcAccessArgs{
	InstanceId: pulumi.String("string"),
	Port:       pulumi.Int(0),
	VpcId:      pulumi.String("string"),
	Name:       pulumi.String("string"),
})

    var vpcAccessResource = new VpcAccess("vpcAccessResource", VpcAccessArgs.builder()
    .instanceId("string")
    .port(0)
    .vpcId("string")
    .name("string")
    .build());

    vpc_access_resource = alicloud.apigateway.VpcAccess("vpcAccessResource",
    instance_id="string",
    port=0,
    vpc_id="string",
    name="string")

    const vpcAccessResource = new alicloud.apigateway.VpcAccess("vpcAccessResource", {
    instanceId: "string",
    port: 0,
    vpcId: "string",
    name: "string",
});

    type: alicloud:apigateway:VpcAccess
properties:
    instanceId: string
    name: string
    port: 0
    vpcId: string

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

    InstanceId string
    ID of the instance in VPC (ECS/Server Load Balance).
    Port int
    ID of the port corresponding to the instance.
    VpcId string
    The vpc id of the vpc authorization.
    Name string
    The name of the vpc authorization.
    InstanceId string
    ID of the instance in VPC (ECS/Server Load Balance).
    Port int
    ID of the port corresponding to the instance.
    VpcId string
    The vpc id of the vpc authorization.
    Name string
    The name of the vpc authorization.
    instanceId String
    ID of the instance in VPC (ECS/Server Load Balance).
    port Integer
    ID of the port corresponding to the instance.
    vpcId String
    The vpc id of the vpc authorization.
    name String
    The name of the vpc authorization.
    instanceId string
    ID of the instance in VPC (ECS/Server Load Balance).
    port number
    ID of the port corresponding to the instance.
    vpcId string
    The vpc id of the vpc authorization.
    name string
    The name of the vpc authorization.
    instance_id str
    ID of the instance in VPC (ECS/Server Load Balance).
    port int
    ID of the port corresponding to the instance.
    vpc_id str
    The vpc id of the vpc authorization.
    name str
    The name of the vpc authorization.
    instanceId String
    ID of the instance in VPC (ECS/Server Load Balance).
    port Number
    ID of the port corresponding to the instance.
    vpcId String
    The vpc id of the vpc authorization.
    name String
    The name of the vpc authorization.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcAccess 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 VpcAccess Resource

    Get an existing VpcAccess 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?: VpcAccessState, opts?: CustomResourceOptions): VpcAccess
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        vpc_id: Optional[str] = None) -> VpcAccess
    func GetVpcAccess(ctx *Context, name string, id IDInput, state *VpcAccessState, opts ...ResourceOption) (*VpcAccess, error)
    public static VpcAccess Get(string name, Input<string> id, VpcAccessState? state, CustomResourceOptions? opts = null)
    public static VpcAccess get(String name, Output<String> id, VpcAccessState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    InstanceId string
    ID of the instance in VPC (ECS/Server Load Balance).
    Name string
    The name of the vpc authorization.
    Port int
    ID of the port corresponding to the instance.
    VpcId string
    The vpc id of the vpc authorization.
    InstanceId string
    ID of the instance in VPC (ECS/Server Load Balance).
    Name string
    The name of the vpc authorization.
    Port int
    ID of the port corresponding to the instance.
    VpcId string
    The vpc id of the vpc authorization.
    instanceId String
    ID of the instance in VPC (ECS/Server Load Balance).
    name String
    The name of the vpc authorization.
    port Integer
    ID of the port corresponding to the instance.
    vpcId String
    The vpc id of the vpc authorization.
    instanceId string
    ID of the instance in VPC (ECS/Server Load Balance).
    name string
    The name of the vpc authorization.
    port number
    ID of the port corresponding to the instance.
    vpcId string
    The vpc id of the vpc authorization.
    instance_id str
    ID of the instance in VPC (ECS/Server Load Balance).
    name str
    The name of the vpc authorization.
    port int
    ID of the port corresponding to the instance.
    vpc_id str
    The vpc id of the vpc authorization.
    instanceId String
    ID of the instance in VPC (ECS/Server Load Balance).
    name String
    The name of the vpc authorization.
    port Number
    ID of the port corresponding to the instance.
    vpcId String
    The vpc id of the vpc authorization.

    Import

    Api gateway app can be imported using the id, e.g.

    $ pulumi import alicloud:apigateway/vpcAccess:VpcAccess example "APiGatewayVpc:vpc-aswcj19ajsz:i-ajdjfsdlf:8080"

    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.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud