1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. ecs
  5. EcsKeyPairAttachment
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.ecs.EcsKeyPairAttachment

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    Provides a ECS Key Pair Attachment resource.

    For information about ECS Key Pair Attachment and how to use it, see What is Key Pair Attachment.

    NOTE: Available since v1.121.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    import * as random from "@pulumi/random";
    
    const example = alicloud.getZones({
        availableResourceCreation: "Instance",
    });
    const exampleGetInstanceTypes = example.then(example => alicloud.ecs.getInstanceTypes({
        availabilityZone: example.zones?.[0]?.id,
        cpuCoreCount: 1,
        memorySize: 2,
    }));
    const exampleGetImages = alicloud.ecs.getImages({
        nameRegex: "^ubuntu_[0-9]+_[0-9]+_x64*",
        owners: "system",
    });
    const exampleNetwork = new alicloud.vpc.Network("example", {
        vpcName: "terraform-example",
        cidrBlock: "172.17.3.0/24",
    });
    const exampleSwitch = new alicloud.vpc.Switch("example", {
        vswitchName: "terraform-example",
        cidrBlock: "172.17.3.0/24",
        vpcId: exampleNetwork.id,
        zoneId: example.then(example => example.zones?.[0]?.id),
    });
    const exampleSecurityGroup = new alicloud.ecs.SecurityGroup("example", {
        name: "terraform-example",
        vpcId: exampleNetwork.id,
    });
    const exampleInstance = new alicloud.ecs.Instance("example", {
        imageId: exampleGetImages.then(exampleGetImages => exampleGetImages.images?.[0]?.id),
        instanceType: exampleGetInstanceTypes.then(exampleGetInstanceTypes => exampleGetInstanceTypes.instanceTypes?.[0]?.id),
        availabilityZone: example.then(example => example.zones?.[0]?.id),
        securityGroups: [exampleSecurityGroup.id],
        instanceName: "terraform-example",
        internetChargeType: "PayByBandwidth",
        vswitchId: exampleSwitch.id,
    });
    const _default = new random.index.Integer("default", {
        min: 10000,
        max: 99999,
    });
    const exampleEcsKeyPair = new alicloud.ecs.EcsKeyPair("example", {keyPairName: `tf-example-${_default.result}`});
    const exampleEcsKeyPairAttachment = new alicloud.ecs.EcsKeyPairAttachment("example", {
        keyPairName: exampleEcsKeyPair.keyPairName,
        instanceIds: [exampleInstance.id],
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    import pulumi_random as random
    
    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_get_images = alicloud.ecs.get_images(name_regex="^ubuntu_[0-9]+_[0-9]+_x64*",
        owners="system")
    example_network = alicloud.vpc.Network("example",
        vpc_name="terraform-example",
        cidr_block="172.17.3.0/24")
    example_switch = alicloud.vpc.Switch("example",
        vswitch_name="terraform-example",
        cidr_block="172.17.3.0/24",
        vpc_id=example_network.id,
        zone_id=example.zones[0].id)
    example_security_group = alicloud.ecs.SecurityGroup("example",
        name="terraform-example",
        vpc_id=example_network.id)
    example_instance = alicloud.ecs.Instance("example",
        image_id=example_get_images.images[0].id,
        instance_type=example_get_instance_types.instance_types[0].id,
        availability_zone=example.zones[0].id,
        security_groups=[example_security_group.id],
        instance_name="terraform-example",
        internet_charge_type="PayByBandwidth",
        vswitch_id=example_switch.id)
    default = random.index.Integer("default",
        min=10000,
        max=99999)
    example_ecs_key_pair = alicloud.ecs.EcsKeyPair("example", key_pair_name=f"tf-example-{default['result']}")
    example_ecs_key_pair_attachment = alicloud.ecs.EcsKeyPairAttachment("example",
        key_pair_name=example_ecs_key_pair.key_pair_name,
        instance_ids=[example_instance.id])
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
    	"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
    		}
    		exampleGetImages, err := ecs.GetImages(ctx, &ecs.GetImagesArgs{
    			NameRegex: pulumi.StringRef("^ubuntu_[0-9]+_[0-9]+_x64*"),
    			Owners:    pulumi.StringRef("system"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
    			VpcName:   pulumi.String("terraform-example"),
    			CidrBlock: pulumi.String("172.17.3.0/24"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
    			VswitchName: pulumi.String("terraform-example"),
    			CidrBlock:   pulumi.String("172.17.3.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"),
    			VpcId: exampleNetwork.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleInstance, err := ecs.NewInstance(ctx, "example", &ecs.InstanceArgs{
    			ImageId:          pulumi.String(exampleGetImages.Images[0].Id),
    			InstanceType:     pulumi.String(exampleGetInstanceTypes.InstanceTypes[0].Id),
    			AvailabilityZone: pulumi.String(example.Zones[0].Id),
    			SecurityGroups: pulumi.StringArray{
    				exampleSecurityGroup.ID(),
    			},
    			InstanceName:       pulumi.String("terraform-example"),
    			InternetChargeType: pulumi.String("PayByBandwidth"),
    			VswitchId:          exampleSwitch.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = random.NewInteger(ctx, "default", &random.IntegerArgs{
    			Min: 10000,
    			Max: 99999,
    		})
    		if err != nil {
    			return err
    		}
    		exampleEcsKeyPair, err := ecs.NewEcsKeyPair(ctx, "example", &ecs.EcsKeyPairArgs{
    			KeyPairName: pulumi.String(fmt.Sprintf("tf-example-%v", _default.Result)),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ecs.NewEcsKeyPairAttachment(ctx, "example", &ecs.EcsKeyPairAttachmentArgs{
    			KeyPairName: exampleEcsKeyPair.KeyPairName,
    			InstanceIds: pulumi.StringArray{
    				exampleInstance.ID(),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    using Random = Pulumi.Random;
    
    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 exampleGetImages = AliCloud.Ecs.GetImages.Invoke(new()
        {
            NameRegex = "^ubuntu_[0-9]+_[0-9]+_x64*",
            Owners = "system",
        });
    
        var exampleNetwork = new AliCloud.Vpc.Network("example", new()
        {
            VpcName = "terraform-example",
            CidrBlock = "172.17.3.0/24",
        });
    
        var exampleSwitch = new AliCloud.Vpc.Switch("example", new()
        {
            VswitchName = "terraform-example",
            CidrBlock = "172.17.3.0/24",
            VpcId = exampleNetwork.Id,
            ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        });
    
        var exampleSecurityGroup = new AliCloud.Ecs.SecurityGroup("example", new()
        {
            Name = "terraform-example",
            VpcId = exampleNetwork.Id,
        });
    
        var exampleInstance = new AliCloud.Ecs.Instance("example", new()
        {
            ImageId = exampleGetImages.Apply(getImagesResult => getImagesResult.Images[0]?.Id),
            InstanceType = exampleGetInstanceTypes.Apply(getInstanceTypesResult => getInstanceTypesResult.InstanceTypes[0]?.Id),
            AvailabilityZone = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            SecurityGroups = new[]
            {
                exampleSecurityGroup.Id,
            },
            InstanceName = "terraform-example",
            InternetChargeType = "PayByBandwidth",
            VswitchId = exampleSwitch.Id,
        });
    
        var @default = new Random.Index.Integer("default", new()
        {
            Min = 10000,
            Max = 99999,
        });
    
        var exampleEcsKeyPair = new AliCloud.Ecs.EcsKeyPair("example", new()
        {
            KeyPairName = $"tf-example-{@default.Result}",
        });
    
        var exampleEcsKeyPairAttachment = new AliCloud.Ecs.EcsKeyPairAttachment("example", new()
        {
            KeyPairName = exampleEcsKeyPair.KeyPairName,
            InstanceIds = new[]
            {
                exampleInstance.Id,
            },
        });
    
    });
    
    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.ecs.inputs.GetImagesArgs;
    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.random.integer;
    import com.pulumi.random.IntegerArgs;
    import com.pulumi.alicloud.ecs.EcsKeyPair;
    import com.pulumi.alicloud.ecs.EcsKeyPairArgs;
    import com.pulumi.alicloud.ecs.EcsKeyPairAttachment;
    import com.pulumi.alicloud.ecs.EcsKeyPairAttachmentArgs;
    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());
    
            final var exampleGetImages = EcsFunctions.getImages(GetImagesArgs.builder()
                .nameRegex("^ubuntu_[0-9]+_[0-9]+_x64*")
                .owners("system")
                .build());
    
            var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
                .vpcName("terraform-example")
                .cidrBlock("172.17.3.0/24")
                .build());
    
            var exampleSwitch = new Switch("exampleSwitch", SwitchArgs.builder()
                .vswitchName("terraform-example")
                .cidrBlock("172.17.3.0/24")
                .vpcId(exampleNetwork.id())
                .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .build());
    
            var exampleSecurityGroup = new SecurityGroup("exampleSecurityGroup", SecurityGroupArgs.builder()
                .name("terraform-example")
                .vpcId(exampleNetwork.id())
                .build());
    
            var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
                .imageId(exampleGetImages.applyValue(getImagesResult -> getImagesResult.images()[0].id()))
                .instanceType(exampleGetInstanceTypes.applyValue(getInstanceTypesResult -> getInstanceTypesResult.instanceTypes()[0].id()))
                .availabilityZone(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .securityGroups(exampleSecurityGroup.id())
                .instanceName("terraform-example")
                .internetChargeType("PayByBandwidth")
                .vswitchId(exampleSwitch.id())
                .build());
    
            var default_ = new Integer("default", IntegerArgs.builder()
                .min(10000)
                .max(99999)
                .build());
    
            var exampleEcsKeyPair = new EcsKeyPair("exampleEcsKeyPair", EcsKeyPairArgs.builder()
                .keyPairName(String.format("tf-example-%s", default_.result()))
                .build());
    
            var exampleEcsKeyPairAttachment = new EcsKeyPairAttachment("exampleEcsKeyPairAttachment", EcsKeyPairAttachmentArgs.builder()
                .keyPairName(exampleEcsKeyPair.keyPairName())
                .instanceIds(exampleInstance.id())
                .build());
    
        }
    }
    
    resources:
      exampleNetwork:
        type: alicloud:vpc:Network
        name: example
        properties:
          vpcName: terraform-example
          cidrBlock: 172.17.3.0/24
      exampleSwitch:
        type: alicloud:vpc:Switch
        name: example
        properties:
          vswitchName: terraform-example
          cidrBlock: 172.17.3.0/24
          vpcId: ${exampleNetwork.id}
          zoneId: ${example.zones[0].id}
      exampleSecurityGroup:
        type: alicloud:ecs:SecurityGroup
        name: example
        properties:
          name: terraform-example
          vpcId: ${exampleNetwork.id}
      exampleInstance:
        type: alicloud:ecs:Instance
        name: example
        properties:
          imageId: ${exampleGetImages.images[0].id}
          instanceType: ${exampleGetInstanceTypes.instanceTypes[0].id}
          availabilityZone: ${example.zones[0].id}
          securityGroups:
            - ${exampleSecurityGroup.id}
          instanceName: terraform-example
          internetChargeType: PayByBandwidth
          vswitchId: ${exampleSwitch.id}
      default:
        type: random:integer
        properties:
          min: 10000
          max: 99999
      exampleEcsKeyPair:
        type: alicloud:ecs:EcsKeyPair
        name: example
        properties:
          keyPairName: tf-example-${default.result}
      exampleEcsKeyPairAttachment:
        type: alicloud:ecs:EcsKeyPairAttachment
        name: example
        properties:
          keyPairName: ${exampleEcsKeyPair.keyPairName}
          instanceIds:
            - ${exampleInstance.id}
    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_[0-9]+_[0-9]+_x64*
            owners: system
    

    Create EcsKeyPairAttachment Resource

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

    Constructor syntax

    new EcsKeyPairAttachment(name: string, args: EcsKeyPairAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def EcsKeyPairAttachment(resource_name: str,
                             args: EcsKeyPairAttachmentArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def EcsKeyPairAttachment(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             instance_ids: Optional[Sequence[str]] = None,
                             force: Optional[bool] = None,
                             key_name: Optional[str] = None,
                             key_pair_name: Optional[str] = None)
    func NewEcsKeyPairAttachment(ctx *Context, name string, args EcsKeyPairAttachmentArgs, opts ...ResourceOption) (*EcsKeyPairAttachment, error)
    public EcsKeyPairAttachment(string name, EcsKeyPairAttachmentArgs args, CustomResourceOptions? opts = null)
    public EcsKeyPairAttachment(String name, EcsKeyPairAttachmentArgs args)
    public EcsKeyPairAttachment(String name, EcsKeyPairAttachmentArgs args, CustomResourceOptions options)
    
    type: alicloud:ecs:EcsKeyPairAttachment
    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 EcsKeyPairAttachmentArgs
    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 EcsKeyPairAttachmentArgs
    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 EcsKeyPairAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EcsKeyPairAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EcsKeyPairAttachmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var ecsKeyPairAttachmentResource = new AliCloud.Ecs.EcsKeyPairAttachment("ecsKeyPairAttachmentResource", new()
    {
        InstanceIds = new[]
        {
            "string",
        },
        Force = false,
        KeyPairName = "string",
    });
    
    example, err := ecs.NewEcsKeyPairAttachment(ctx, "ecsKeyPairAttachmentResource", &ecs.EcsKeyPairAttachmentArgs{
    	InstanceIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Force:       pulumi.Bool(false),
    	KeyPairName: pulumi.String("string"),
    })
    
    var ecsKeyPairAttachmentResource = new EcsKeyPairAttachment("ecsKeyPairAttachmentResource", EcsKeyPairAttachmentArgs.builder()
        .instanceIds("string")
        .force(false)
        .keyPairName("string")
        .build());
    
    ecs_key_pair_attachment_resource = alicloud.ecs.EcsKeyPairAttachment("ecsKeyPairAttachmentResource",
        instance_ids=["string"],
        force=False,
        key_pair_name="string")
    
    const ecsKeyPairAttachmentResource = new alicloud.ecs.EcsKeyPairAttachment("ecsKeyPairAttachmentResource", {
        instanceIds: ["string"],
        force: false,
        keyPairName: "string",
    });
    
    type: alicloud:ecs:EcsKeyPairAttachment
    properties:
        force: false
        instanceIds:
            - string
        keyPairName: string
    

    EcsKeyPairAttachment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EcsKeyPairAttachment resource accepts the following input properties:

    InstanceIds List<string>
    The list of ECS instance's IDs.
    Force bool
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    KeyName string
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    KeyPairName string
    The name of key pair used to bind.
    InstanceIds []string
    The list of ECS instance's IDs.
    Force bool
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    KeyName string
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    KeyPairName string
    The name of key pair used to bind.
    instanceIds List<String>
    The list of ECS instance's IDs.
    force Boolean
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    keyName String
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    keyPairName String
    The name of key pair used to bind.
    instanceIds string[]
    The list of ECS instance's IDs.
    force boolean
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    keyName string
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    keyPairName string
    The name of key pair used to bind.
    instance_ids Sequence[str]
    The list of ECS instance's IDs.
    force bool
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    key_name str
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    key_pair_name str
    The name of key pair used to bind.
    instanceIds List<String>
    The list of ECS instance's IDs.
    force Boolean
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    keyName String
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    keyPairName String
    The name of key pair used to bind.

    Outputs

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

    Get an existing EcsKeyPairAttachment 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?: EcsKeyPairAttachmentState, opts?: CustomResourceOptions): EcsKeyPairAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            force: Optional[bool] = None,
            instance_ids: Optional[Sequence[str]] = None,
            key_name: Optional[str] = None,
            key_pair_name: Optional[str] = None) -> EcsKeyPairAttachment
    func GetEcsKeyPairAttachment(ctx *Context, name string, id IDInput, state *EcsKeyPairAttachmentState, opts ...ResourceOption) (*EcsKeyPairAttachment, error)
    public static EcsKeyPairAttachment Get(string name, Input<string> id, EcsKeyPairAttachmentState? state, CustomResourceOptions? opts = null)
    public static EcsKeyPairAttachment get(String name, Output<String> id, EcsKeyPairAttachmentState 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:
    Force bool
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    InstanceIds List<string>
    The list of ECS instance's IDs.
    KeyName string
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    KeyPairName string
    The name of key pair used to bind.
    Force bool
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    InstanceIds []string
    The list of ECS instance's IDs.
    KeyName string
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    KeyPairName string
    The name of key pair used to bind.
    force Boolean
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    instanceIds List<String>
    The list of ECS instance's IDs.
    keyName String
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    keyPairName String
    The name of key pair used to bind.
    force boolean
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    instanceIds string[]
    The list of ECS instance's IDs.
    keyName string
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    keyPairName string
    The name of key pair used to bind.
    force bool
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    instance_ids Sequence[str]
    The list of ECS instance's IDs.
    key_name str
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    key_pair_name str
    The name of key pair used to bind.
    force Boolean
    Set it to true and it will reboot instances which attached with the key pair to make key pair affect immediately.
    instanceIds List<String>
    The list of ECS instance's IDs.
    keyName String
    New field 'key_pair_name' instead.

    Deprecated: Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.

    keyPairName String
    The name of key pair used to bind.

    Import

    ECS Key Pair Attachment can be imported using the id, e.g.

    $ pulumi import alicloud:ecs/ecsKeyPairAttachment:EcsKeyPairAttachment example <key_pair_name>:<instance_ids>
    

    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.57.0 published on Saturday, Jun 15, 2024 by Pulumi