1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. ecs
  5. EcsKeyPairAttachment
Viewing docs for Alibaba Cloud v3.98.0
published on Saturday, Apr 4, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

alicloud.ecs.EcsKeyPairAttachment

alicloud logo
Viewing docs for Alibaba Cloud v3.98.0
published on Saturday, Apr 4, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

    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 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,
}));
const defaultInteger = new random.index.Integer("default", {
    min: 10000,
    max: 99999,
});
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,
});
const defaultEcsKeyPair = new alicloud.ecs.EcsKeyPair("default", {keyPairName: `${name}-${defaultInteger.result}`});
const defaultEcsKeyPairAttachment = new alicloud.ecs.EcsKeyPairAttachment("default", {
    keyPairName: defaultEcsKeyPair.id,
    instanceIds: [defaultInstance.id],
});

    import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random

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)
default_integer = random.index.Integer("default",
    min=10000,
    max=99999)
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)
default_ecs_key_pair = alicloud.ecs.EcsKeyPair("default", key_pair_name=f"{name}-{default_integer['result']}")
default_ecs_key_pair_attachment = alicloud.ecs.EcsKeyPairAttachment("default",
    key_pair_name=default_ecs_key_pair.id,
    instance_ids=[default_instance.id])

    package main

import (
	"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"
	"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),
}, nil);
if err != nil {
return err
}
defaultInteger, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
Min: 10000,
Max: 99999,
})
if err != nil {
return err
}
defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
VpcName: pulumi.String(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(pulumi.String(name)),
VpcId: defaultNetwork.ID(),
CidrBlock: pulumi.String("192.168.192.0/24"),
ZoneId: pulumi.String(pulumi.String(_default.Zones[0].Id)),
})
if err != nil {
return err
}
defaultSecurityGroup, err := ecs.NewSecurityGroup(ctx, "default", &ecs.SecurityGroupArgs{
Name: pulumi.String(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(pulumi.String(defaultGetImages.Images[0].Id)),
InstanceType: pulumi.String(pulumi.String(defaultGetInstanceTypes.InstanceTypes[0].Id)),
SecurityGroups: splat0,
InternetChargeType: pulumi.String("PayByTraffic"),
InternetMaxBandwidthOut: pulumi.Int(10),
AvailabilityZone: pulumi.String(pulumi.String(defaultGetInstanceTypes.InstanceTypes[0].AvailabilityZones[0])),
InstanceChargeType: pulumi.String("PostPaid"),
SystemDiskCategory: pulumi.String("cloud_efficiency"),
VswitchId: defaultSwitch.ID(),
InstanceName: pulumi.String(pulumi.String(name)),
})
if err != nil {
return err
}
defaultEcsKeyPair, err := ecs.NewEcsKeyPair(ctx, "default", &ecs.EcsKeyPairArgs{
KeyPairName: pulumi.Sprintf("%v-%v", name, defaultInteger.Result),
})
if err != nil {
return err
}
_, err = ecs.NewEcsKeyPairAttachment(ctx, "default", &ecs.EcsKeyPairAttachmentArgs{
KeyPairName: defaultEcsKeyPair.ID(),
InstanceIds: pulumi.StringArray{
defaultInstance.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 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),
    });

    var defaultInteger = new Random.Index.Integer("default", new()
    {
        Min = 10000,
        Max = 99999,
    });

    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,
    });

    var defaultEcsKeyPair = new AliCloud.Ecs.EcsKeyPair("default", new()
    {
        KeyPairName = $"{name}-{defaultInteger.Result}",
    });

    var defaultEcsKeyPairAttachment = new AliCloud.Ecs.EcsKeyPairAttachment("default", new()
    {
        KeyPairName = defaultEcsKeyPair.Id,
        InstanceIds = new[]
        {
            defaultInstance.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.GetImagesArgs;
import com.pulumi.alicloud.ecs.inputs.GetInstanceTypesArgs;
import com.pulumi.random.Integer;
import com.pulumi.random.IntegerArgs;
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.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 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())
            .build());

        var defaultInteger = new Integer("defaultInteger", IntegerArgs.builder()
            .min(10000)
            .max(99999)
            .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)
            .build());

        var defaultEcsKeyPair = new EcsKeyPair("defaultEcsKeyPair", EcsKeyPairArgs.builder()
            .keyPairName(String.format("%s-%s", name,defaultInteger.result()))
            .build());

        var defaultEcsKeyPairAttachment = new EcsKeyPairAttachment("defaultEcsKeyPairAttachment", EcsKeyPairAttachmentArgs.builder()
            .keyPairName(defaultEcsKeyPair.id())
            .instanceIds(defaultInstance.id())
            .build());

    }
}

    Example coming soon!

    📚 Need more examples? VIEW MORE EXAMPLES

    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.

    Constructor 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EcsKeyPairAttachment resource accepts the following input properties:

    InstanceIds List<string>
    The IDs of instances to which you want to bind the SSH key pair.
    Force bool
    Specifies whether to make the key pair effective immediately. Valid values:
    KeyName string

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    KeyPairName string
    The name of the SSH key pair.
    InstanceIds []string
    The IDs of instances to which you want to bind the SSH key pair.
    Force bool
    Specifies whether to make the key pair effective immediately. Valid values:
    KeyName string

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    KeyPairName string
    The name of the SSH key pair.
    instanceIds List<String>
    The IDs of instances to which you want to bind the SSH key pair.
    force Boolean
    Specifies whether to make the key pair effective immediately. Valid values:
    keyName String

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    keyPairName String
    The name of the SSH key pair.
    instanceIds string[]
    The IDs of instances to which you want to bind the SSH key pair.
    force boolean
    Specifies whether to make the key pair effective immediately. Valid values:
    keyName string

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    keyPairName string
    The name of the SSH key pair.
    instance_ids Sequence[str]
    The IDs of instances to which you want to bind the SSH key pair.
    force bool
    Specifies whether to make the key pair effective immediately. Valid values:
    key_name str

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    key_pair_name str
    The name of the SSH key pair.
    instanceIds List<String>
    The IDs of instances to which you want to bind the SSH key pair.
    force Boolean
    Specifies whether to make the key pair effective immediately. Valid values:
    keyName String

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    keyPairName String
    The name of the SSH key pair.

    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)
    resources:  _:    type: alicloud:ecs:EcsKeyPairAttachment    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:
    Force bool
    Specifies whether to make the key pair effective immediately. Valid values:
    InstanceIds List<string>
    The IDs of instances to which you want to bind the SSH key pair.
    KeyName string

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    KeyPairName string
    The name of the SSH key pair.
    Force bool
    Specifies whether to make the key pair effective immediately. Valid values:
    InstanceIds []string
    The IDs of instances to which you want to bind the SSH key pair.
    KeyName string

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    KeyPairName string
    The name of the SSH key pair.
    force Boolean
    Specifies whether to make the key pair effective immediately. Valid values:
    instanceIds List<String>
    The IDs of instances to which you want to bind the SSH key pair.
    keyName String

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    keyPairName String
    The name of the SSH key pair.
    force boolean
    Specifies whether to make the key pair effective immediately. Valid values:
    instanceIds string[]
    The IDs of instances to which you want to bind the SSH key pair.
    keyName string

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    keyPairName string
    The name of the SSH key pair.
    force bool
    Specifies whether to make the key pair effective immediately. Valid values:
    instance_ids Sequence[str]
    The IDs of instances to which you want to bind the SSH key pair.
    key_name str

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    key_pair_name str
    The name of the SSH key pair.
    force Boolean
    Specifies whether to make the key pair effective immediately. Valid values:
    instanceIds List<String>
    The IDs of instances to which you want to bind the SSH key pair.
    keyName String

    Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    WARNING: If force set to true, it it will reboot instances which attached with the key pair to make key pair effective immediately.

    Deprecated: Field keyName has been deprecated from provider version 1.121.0. New field keyPairName instead.

    keyPairName String
    The name of the SSH key pair.

    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
    Viewing docs for Alibaba Cloud v3.98.0
    published on Saturday, Apr 4, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-alicloud
      Try Pulumi Cloud free. Your team will thank you.