@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
256 lines (255 loc) • 9.44 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Attaches a Network Interface to an Instance.
*
* ## Example Usage
* ### Attach a port (under the specified network) to the ECS instance and generate a random IP address
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const instanceId = config.requireObject("instanceId");
* const networkId = config.requireObject("networkId");
* const test = new huaweicloud.ecs.InterfaceAttach("test", {
* instanceId: instanceId,
* networkId: networkId,
* });
* ```
* ### Attach a port (under the specified network) to the ECS instance and use the custom security groups
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const instanceId = config.requireObject("instanceId");
* const networkId = config.requireObject("networkId");
* const securityGroupIds = config.requireObject("securityGroupIds");
* const test = new huaweicloud.ecs.InterfaceAttach("test", {
* instanceId: instanceId,
* networkId: networkId,
* securityGroupIds: securityGroupIds,
* });
* ```
* ### Attach a custom port to the ECS instance
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as huaweicloud from "@pulumi/huaweicloud";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const securityGroupId = config.requireObject("securityGroupId");
* const mynet = huaweicloud.Vpc.getSubnet({
* name: "subnet-default",
* });
* const myport = mynet.then(mynet => huaweicloud.Vpc.getPort({
* networkId: mynet.id,
* fixedIp: "192.168.0.100",
* }));
* const myinstance = new huaweicloud.ecs.Instance("myinstance", {
* imageId: "ad091b52-742f-469e-8f3c-fd81cadf0743",
* flavorId: "s6.small.1",
* keyPair: "my_key_pair_name",
* securityGroupIds: [securityGroupId],
* availabilityZone: "cn-north-4a",
* networks: [{
* uuid: "55534eaa-533a-419d-9b40-ec427ea7195a",
* }],
* });
* const attached = new huaweicloud.ecs.InterfaceAttach("attached", {
* instanceId: myinstance.id,
* portId: myport.then(myport => myport.id),
* });
* ```
*
* ## Import
*
* Interface Attachments can be imported using the Instance ID and Port ID separated by a slash, e.g.
*
* ```sh
* $ pulumi import huaweicloud:Ecs/interfaceAttach:InterfaceAttach ai_1 89c60255-9bd6-460c-822a-e2b959ede9d2/45670584-225f-46c3-b33e-6707b589b666
* ```
*/
export declare class InterfaceAttach extends pulumi.CustomResource {
/**
* Get an existing InterfaceAttach resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InterfaceAttachState, opts?: pulumi.CustomResourceOptions): InterfaceAttach;
/**
* Returns true if the given object is an instance of InterfaceAttach. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is InterfaceAttach;
/**
* An IP address to associate with the port.
*/
readonly fixedIp: pulumi.Output<string>;
/**
* The IPv6 address.
*/
readonly fixedIpv6: pulumi.Output<string>;
/**
* The ID of the Instance to attach the Port or Network to.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Specifies the shared bandwidth ID to which the IPv6 NIC attaches.
*/
readonly ipv6BandwidthId: pulumi.Output<string | undefined>;
/**
* Specifies if the NIC supporting IPv6 or not.
*/
readonly ipv6Enable: pulumi.Output<boolean>;
/**
* The MAC address of the NIC.
*/
readonly mac: pulumi.Output<string>;
/**
* The ID of the Network to attach to an Instance. A port will be created
* automatically.
* This option and `portId` are mutually exclusive.
*/
readonly networkId: pulumi.Output<string>;
/**
* The ID of the Port to attach to an Instance.
* This option and `networkId` are mutually exclusive.
*/
readonly portId: pulumi.Output<string>;
/**
* The region in which to create the network interface attache resource. If
* omitted, the provider-level region will be used. Changing this creates a new network interface attache resource.
*/
readonly region: pulumi.Output<string>;
/**
* Specifies the list of security group IDs bound to the specified port.
* Defaults to the default security group.
*/
readonly securityGroupIds: pulumi.Output<string[]>;
/**
* Specifies whether the ECS processes only traffic that is destined specifically
* for it. This function is enabled by default but should be disabled if the ECS functions as a SNAT server or has a
* virtual IP address bound to it.
*/
readonly sourceDestCheck: pulumi.Output<boolean | undefined>;
/**
* Create a InterfaceAttach resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: InterfaceAttachArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InterfaceAttach resources.
*/
export interface InterfaceAttachState {
/**
* An IP address to associate with the port.
*/
fixedIp?: pulumi.Input<string>;
/**
* The IPv6 address.
*/
fixedIpv6?: pulumi.Input<string>;
/**
* The ID of the Instance to attach the Port or Network to.
*/
instanceId?: pulumi.Input<string>;
/**
* Specifies the shared bandwidth ID to which the IPv6 NIC attaches.
*/
ipv6BandwidthId?: pulumi.Input<string>;
/**
* Specifies if the NIC supporting IPv6 or not.
*/
ipv6Enable?: pulumi.Input<boolean>;
/**
* The MAC address of the NIC.
*/
mac?: pulumi.Input<string>;
/**
* The ID of the Network to attach to an Instance. A port will be created
* automatically.
* This option and `portId` are mutually exclusive.
*/
networkId?: pulumi.Input<string>;
/**
* The ID of the Port to attach to an Instance.
* This option and `networkId` are mutually exclusive.
*/
portId?: pulumi.Input<string>;
/**
* The region in which to create the network interface attache resource. If
* omitted, the provider-level region will be used. Changing this creates a new network interface attache resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the list of security group IDs bound to the specified port.
* Defaults to the default security group.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Specifies whether the ECS processes only traffic that is destined specifically
* for it. This function is enabled by default but should be disabled if the ECS functions as a SNAT server or has a
* virtual IP address bound to it.
*/
sourceDestCheck?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a InterfaceAttach resource.
*/
export interface InterfaceAttachArgs {
/**
* An IP address to associate with the port.
*/
fixedIp?: pulumi.Input<string>;
/**
* The ID of the Instance to attach the Port or Network to.
*/
instanceId: pulumi.Input<string>;
/**
* Specifies the shared bandwidth ID to which the IPv6 NIC attaches.
*/
ipv6BandwidthId?: pulumi.Input<string>;
/**
* Specifies if the NIC supporting IPv6 or not.
*/
ipv6Enable?: pulumi.Input<boolean>;
/**
* The ID of the Network to attach to an Instance. A port will be created
* automatically.
* This option and `portId` are mutually exclusive.
*/
networkId?: pulumi.Input<string>;
/**
* The ID of the Port to attach to an Instance.
* This option and `networkId` are mutually exclusive.
*/
portId?: pulumi.Input<string>;
/**
* The region in which to create the network interface attache resource. If
* omitted, the provider-level region will be used. Changing this creates a new network interface attache resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the list of security group IDs bound to the specified port.
* Defaults to the default security group.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Specifies whether the ECS processes only traffic that is destined specifically
* for it. This function is enabled by default but should be disabled if the ECS functions as a SNAT server or has a
* virtual IP address bound to it.
*/
sourceDestCheck?: pulumi.Input<boolean>;
}