Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = alicloud.getZones({
availableDiskCategory: "cloud_efficiency",
availableResourceCreation: "VSwitch",
});
const defaultGetImages = alicloud.ecs.getImages({
nameRegex: "^ubuntu_[0-9]+_[0-9]+_x64*",
mostRecent: true,
owners: "system",
});
const defaultGetInstanceTypes = Promise.all([_default, defaultGetImages]).then(([_default, defaultGetImages]) => alicloud.ecs.getInstanceTypes({
availabilityZone: _default.zones?.[0]?.id,
imageId: defaultGetImages.images?.[0]?.id,
systemDiskCategory: "cloud_efficiency",
}));
const defaultNetwork = new alicloud.vpc.Network("default", {
vpcName: name,
cidrBlock: "192.168.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
vswitchName: name,
vpcId: defaultNetwork.id,
cidrBlock: "192.168.192.0/24",
zoneId: _default.then(_default => _default.zones?.[0]?.id),
});
const defaultSecurityGroup = new alicloud.ecs.SecurityGroup("default", {
name: name,
vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.ecs.Instance("default", {
imageId: defaultGetImages.then(defaultGetImages => defaultGetImages.images?.[0]?.id),
instanceType: defaultGetInstanceTypes.then(defaultGetInstanceTypes => defaultGetInstanceTypes.instanceTypes?.[0]?.id),
securityGroups: [defaultSecurityGroup].map(__item => __item.id),
internetChargeType: "PayByTraffic",
internetMaxBandwidthOut: 10,
availabilityZone: defaultGetInstanceTypes.then(defaultGetInstanceTypes => defaultGetInstanceTypes.instanceTypes?.[0]?.availabilityZones?.[0]),
instanceChargeType: "PostPaid",
systemDiskCategory: "cloud_efficiency",
vswitchId: defaultSwitch.id,
instanceName: name,
description: name,
});
const defaultVpcAccess = new alicloud.apigateway.VpcAccess("default", {
name: name,
vpcId: defaultNetwork.id,
instanceId: defaultInstance.id,
port: 8080,
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform-example"
default = alicloud.get_zones(available_disk_category="cloud_efficiency",
available_resource_creation="VSwitch")
default_get_images = alicloud.ecs.get_images(name_regex="^ubuntu_[0-9]+_[0-9]+_x64*",
most_recent=True,
owners="system")
default_get_instance_types = alicloud.ecs.get_instance_types(availability_zone=default.zones[0].id,
image_id=default_get_images.images[0].id,
system_disk_category="cloud_efficiency")
default_network = alicloud.vpc.Network("default",
vpc_name=name,
cidr_block="192.168.0.0/16")
default_switch = alicloud.vpc.Switch("default",
vswitch_name=name,
vpc_id=default_network.id,
cidr_block="192.168.192.0/24",
zone_id=default.zones[0].id)
default_security_group = alicloud.ecs.SecurityGroup("default",
name=name,
vpc_id=default_network.id)
default_instance = alicloud.ecs.Instance("default",
image_id=default_get_images.images[0].id,
instance_type=default_get_instance_types.instance_types[0].id,
security_groups=[__item.id for __item in [default_security_group]],
internet_charge_type="PayByTraffic",
internet_max_bandwidth_out=10,
availability_zone=default_get_instance_types.instance_types[0].availability_zones[0],
instance_charge_type="PostPaid",
system_disk_category="cloud_efficiency",
vswitch_id=default_switch.id,
instance_name=name,
description=name)
default_vpc_access = alicloud.apigateway.VpcAccess("default",
name=name,
vpc_id=default_network.id,
instance_id=default_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"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "terraform-example";
if param := cfg.Get("name"); param != ""{
name = param
}
_default, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
AvailableDiskCategory: pulumi.StringRef("cloud_efficiency"),
AvailableResourceCreation: pulumi.StringRef("VSwitch"),
}, nil);
if err != nil {
return err
}
defaultGetImages, err := ecs.GetImages(ctx, &ecs.GetImagesArgs{
NameRegex: pulumi.StringRef("^ubuntu_[0-9]+_[0-9]+_x64*"),
MostRecent: pulumi.BoolRef(true),
Owners: pulumi.StringRef("system"),
}, nil);
if err != nil {
return err
}
defaultGetInstanceTypes, err := ecs.GetInstanceTypes(ctx, &ecs.GetInstanceTypesArgs{
AvailabilityZone: pulumi.StringRef(_default.Zones[0].Id),
ImageId: pulumi.StringRef(defaultGetImages.Images[0].Id),
SystemDiskCategory: pulumi.StringRef("cloud_efficiency"),
}, nil);
if err != nil {
return err
}
defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
VpcName: pulumi.String(name),
CidrBlock: pulumi.String("192.168.0.0/16"),
})
if err != nil {
return err
}
defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
VswitchName: pulumi.String(name),
VpcId: defaultNetwork.ID(),
CidrBlock: pulumi.String("192.168.192.0/24"),
ZoneId: pulumi.String(_default.Zones[0].Id),
})
if err != nil {
return err
}
defaultSecurityGroup, err := ecs.NewSecurityGroup(ctx, "default", &ecs.SecurityGroupArgs{
Name: pulumi.String(name),
VpcId: defaultNetwork.ID(),
})
if err != nil {
return err
}
var splat0 pulumi.StringArray
for _, val0 := range %!v(PANIC=Format method: fatal: An assertion has failed: tok: ) {
splat0 = append(splat0, val0.ID())
}
defaultInstance, err := ecs.NewInstance(ctx, "default", &ecs.InstanceArgs{
ImageId: pulumi.String(defaultGetImages.Images[0].Id),
InstanceType: pulumi.String(defaultGetInstanceTypes.InstanceTypes[0].Id),
SecurityGroups: splat0,
InternetChargeType: pulumi.String("PayByTraffic"),
InternetMaxBandwidthOut: pulumi.Int(10),
AvailabilityZone: pulumi.String(defaultGetInstanceTypes.InstanceTypes[0].AvailabilityZones[0]),
InstanceChargeType: pulumi.String("PostPaid"),
SystemDiskCategory: pulumi.String("cloud_efficiency"),
VswitchId: defaultSwitch.ID(),
InstanceName: pulumi.String(name),
Description: pulumi.String(name),
})
if err != nil {
return err
}
_, err = apigateway.NewVpcAccess(ctx, "default", &apigateway.VpcAccessArgs{
Name: pulumi.String(name),
VpcId: defaultNetwork.ID(),
InstanceId: defaultInstance.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 config = new Config();
var name = config.Get("name") ?? "terraform-example";
var @default = AliCloud.GetZones.Invoke(new()
{
AvailableDiskCategory = "cloud_efficiency",
AvailableResourceCreation = "VSwitch",
});
var defaultGetImages = AliCloud.Ecs.GetImages.Invoke(new()
{
NameRegex = "^ubuntu_[0-9]+_[0-9]+_x64*",
MostRecent = true,
Owners = "system",
});
var defaultGetInstanceTypes = AliCloud.Ecs.GetInstanceTypes.Invoke(new()
{
AvailabilityZone = @default.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
ImageId = defaultGetImages.Apply(getImagesResult => getImagesResult.Images[0]?.Id),
SystemDiskCategory = "cloud_efficiency",
});
var defaultNetwork = new AliCloud.Vpc.Network("default", new()
{
VpcName = name,
CidrBlock = "192.168.0.0/16",
});
var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
{
VswitchName = name,
VpcId = defaultNetwork.Id,
CidrBlock = "192.168.192.0/24",
ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones[0]?.Id)),
});
var defaultSecurityGroup = new AliCloud.Ecs.SecurityGroup("default", new()
{
Name = name,
VpcId = defaultNetwork.Id,
});
var defaultInstance = new AliCloud.Ecs.Instance("default", new()
{
ImageId = defaultGetImages.Apply(getImagesResult => getImagesResult.Images[0]?.Id),
InstanceType = defaultGetInstanceTypes.Apply(getInstanceTypesResult => getInstanceTypesResult.InstanceTypes[0]?.Id),
SecurityGroups = new[]
{
defaultSecurityGroup,
}.Select(__item => __item.Id).ToList(),
InternetChargeType = "PayByTraffic",
InternetMaxBandwidthOut = 10,
AvailabilityZone = defaultGetInstanceTypes.Apply(getInstanceTypesResult => getInstanceTypesResult.InstanceTypes[0]?.AvailabilityZones[0]),
InstanceChargeType = "PostPaid",
SystemDiskCategory = "cloud_efficiency",
VswitchId = defaultSwitch.Id,
InstanceName = name,
Description = name,
});
var defaultVpcAccess = new AliCloud.ApiGateway.VpcAccess("default", new()
{
Name = name,
VpcId = defaultNetwork.Id,
InstanceId = defaultInstance.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.GetImagesArgs;
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.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 config = ctx.config();
final var name = config.get("name").orElse("terraform-example");
final var default = AlicloudFunctions.getZones(GetZonesArgs.builder()
.availableDiskCategory("cloud_efficiency")
.availableResourceCreation("VSwitch")
.build());
final var defaultGetImages = EcsFunctions.getImages(GetImagesArgs.builder()
.nameRegex("^ubuntu_[0-9]+_[0-9]+_x64*")
.mostRecent(true)
.owners("system")
.build());
final var defaultGetInstanceTypes = EcsFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
.availabilityZone(default_.zones()[0].id())
.imageId(defaultGetImages.images()[0].id())
.systemDiskCategory("cloud_efficiency")
.build());
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.vpcName(name)
.cidrBlock("192.168.0.0/16")
.build());
var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
.vswitchName(name)
.vpcId(defaultNetwork.id())
.cidrBlock("192.168.192.0/24")
.zoneId(default_.zones()[0].id())
.build());
var defaultSecurityGroup = new SecurityGroup("defaultSecurityGroup", SecurityGroupArgs.builder()
.name(name)
.vpcId(defaultNetwork.id())
.build());
var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.imageId(defaultGetImages.images()[0].id())
.instanceType(defaultGetInstanceTypes.instanceTypes()[0].id())
.securityGroups(defaultSecurityGroup.stream().map(element -> element.id()).collect(toList()))
.internetChargeType("PayByTraffic")
.internetMaxBandwidthOut(10)
.availabilityZone(defaultGetInstanceTypes.instanceTypes()[0].availabilityZones()[0])
.instanceChargeType("PostPaid")
.systemDiskCategory("cloud_efficiency")
.vswitchId(defaultSwitch.id())
.instanceName(name)
.description(name)
.build());
var defaultVpcAccess = new VpcAccess("defaultVpcAccess", VpcAccessArgs.builder()
.name(name)
.vpcId(defaultNetwork.id())
.instanceId(defaultInstance.id())
.port(8080)
.build());
}
}
Example coming soon!
📚 Need more examples? VIEW MORE EXAMPLES
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:
- Instance
Id string - The ID of an ECS or SLB instance in the VPC.
- Port int
- The port number that corresponds to the instance.
- Vpc
Id string - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- Name string
- The name of the authorization. The name must be unique.
- Instance
Id string - The ID of an ECS or SLB instance in the VPC.
- Port int
- The port number that corresponds to the instance.
- Vpc
Id string - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- Name string
- The name of the authorization. The name must be unique.
- instance
Id String - The ID of an ECS or SLB instance in the VPC.
- port Integer
- The port number that corresponds to the instance.
- vpc
Id String - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- name String
- The name of the authorization. The name must be unique.
- instance
Id string - The ID of an ECS or SLB instance in the VPC.
- port number
- The port number that corresponds to the instance.
- vpc
Id string - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- name string
- The name of the authorization. The name must be unique.
- instance_
id str - The ID of an ECS or SLB instance in the VPC.
- port int
- The port number that corresponds to the instance.
- vpc_
id str - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- name str
- The name of the authorization. The name must be unique.
- instance
Id String - The ID of an ECS or SLB instance in the VPC.
- port Number
- The port number that corresponds to the instance.
- vpc
Id String - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- name String
- The name of the authorization. The name must be unique.
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) -> VpcAccessfunc 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)resources: _: type: alicloud:apigateway:VpcAccess 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.
- Instance
Id string - The ID of an ECS or SLB instance in the VPC.
- Name string
- The name of the authorization. The name must be unique.
- Port int
- The port number that corresponds to the instance.
- Vpc
Id string - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- Instance
Id string - The ID of an ECS or SLB instance in the VPC.
- Name string
- The name of the authorization. The name must be unique.
- Port int
- The port number that corresponds to the instance.
- Vpc
Id string - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- instance
Id String - The ID of an ECS or SLB instance in the VPC.
- name String
- The name of the authorization. The name must be unique.
- port Integer
- The port number that corresponds to the instance.
- vpc
Id String - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- instance
Id string - The ID of an ECS or SLB instance in the VPC.
- name string
- The name of the authorization. The name must be unique.
- port number
- The port number that corresponds to the instance.
- vpc
Id string - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- instance_
id str - The ID of an ECS or SLB instance in the VPC.
- name str
- The name of the authorization. The name must be unique.
- port int
- The port number that corresponds to the instance.
- vpc_
id str - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
- instance
Id String - The ID of an ECS or SLB instance in the VPC.
- name String
- The name of the authorization. The name must be unique.
- port Number
- The port number that corresponds to the instance.
- vpc
Id String - The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.
Import
Api Gateway Vpc Access can be imported using the id, e.g.
$ pulumi import alicloud:apigateway/vpcAccess:VpcAccess example <name>:<vpc_id>:<instance_id>:<port>
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
alicloudTerraform Provider.
