Alibaba Cloud v3.38.0, Jun 2 23
Alibaba Cloud v3.38.0, Jun 2 23
alicloud.ecs.EcsKeyPair
Explore with Pulumi AI
Provides a ECS Key Pair resource.
For information about ECS Key Pair and how to use it, see What is Key Pair.
NOTE: Available in v1.121.0+.
Example Usage
Basic Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var example = new AliCloud.Ecs.EcsKeyPair("example", new()
{
KeyPairName = "key_pair_name",
});
// Using name prefix to build key pair
var prefix = new AliCloud.Ecs.EcsKeyPair("prefix", new()
{
KeyNamePrefix = "terraform-test-key-pair-prefix",
});
// Import an existing public key to build a alicloud key pair
var publickey = new AliCloud.Ecs.EcsKeyPair("publickey", new()
{
KeyPairName = "my_public_key",
PublicKey = "ssh-rsa AAAAB3Nza12345678qwertyuudsfsg",
});
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ecs.NewEcsKeyPair(ctx, "example", &ecs.EcsKeyPairArgs{
KeyPairName: pulumi.String("key_pair_name"),
})
if err != nil {
return err
}
_, err = ecs.NewEcsKeyPair(ctx, "prefix", &ecs.EcsKeyPairArgs{
KeyNamePrefix: pulumi.String("terraform-test-key-pair-prefix"),
})
if err != nil {
return err
}
_, err = ecs.NewEcsKeyPair(ctx, "publickey", &ecs.EcsKeyPairArgs{
KeyPairName: pulumi.String("my_public_key"),
PublicKey: pulumi.String("ssh-rsa AAAAB3Nza12345678qwertyuudsfsg"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ecs.EcsKeyPair;
import com.pulumi.alicloud.ecs.EcsKeyPairArgs;
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) {
var example = new EcsKeyPair("example", EcsKeyPairArgs.builder()
.keyPairName("key_pair_name")
.build());
var prefix = new EcsKeyPair("prefix", EcsKeyPairArgs.builder()
.keyNamePrefix("terraform-test-key-pair-prefix")
.build());
var publickey = new EcsKeyPair("publickey", EcsKeyPairArgs.builder()
.keyPairName("my_public_key")
.publicKey("ssh-rsa AAAAB3Nza12345678qwertyuudsfsg")
.build());
}
}
import pulumi
import pulumi_alicloud as alicloud
example = alicloud.ecs.EcsKeyPair("example", key_pair_name="key_pair_name")
# Using name prefix to build key pair
prefix = alicloud.ecs.EcsKeyPair("prefix", key_name_prefix="terraform-test-key-pair-prefix")
# Import an existing public key to build a alicloud key pair
publickey = alicloud.ecs.EcsKeyPair("publickey",
key_pair_name="my_public_key",
public_key="ssh-rsa AAAAB3Nza12345678qwertyuudsfsg")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const example = new alicloud.ecs.EcsKeyPair("example", {keyPairName: "key_pair_name"});
// Using name prefix to build key pair
const prefix = new alicloud.ecs.EcsKeyPair("prefix", {keyNamePrefix: "terraform-test-key-pair-prefix"});
// Import an existing public key to build a alicloud key pair
const publickey = new alicloud.ecs.EcsKeyPair("publickey", {
keyPairName: "my_public_key",
publicKey: "ssh-rsa AAAAB3Nza12345678qwertyuudsfsg",
});
resources:
example:
type: alicloud:ecs:EcsKeyPair
properties:
keyPairName: key_pair_name
# Using name prefix to build key pair
prefix:
type: alicloud:ecs:EcsKeyPair
properties:
keyNamePrefix: terraform-test-key-pair-prefix
# Import an existing public key to build a alicloud key pair
publickey:
type: alicloud:ecs:EcsKeyPair
properties:
keyPairName: my_public_key
publicKey: ssh-rsa AAAAB3Nza12345678qwertyuudsfsg
Create EcsKeyPair Resource
new EcsKeyPair(name: string, args?: EcsKeyPairArgs, opts?: CustomResourceOptions);
@overload
def EcsKeyPair(resource_name: str,
opts: Optional[ResourceOptions] = None,
key_file: Optional[str] = None,
key_name: Optional[str] = None,
key_name_prefix: Optional[str] = None,
key_pair_name: Optional[str] = None,
public_key: Optional[str] = None,
resource_group_id: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None)
@overload
def EcsKeyPair(resource_name: str,
args: Optional[EcsKeyPairArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewEcsKeyPair(ctx *Context, name string, args *EcsKeyPairArgs, opts ...ResourceOption) (*EcsKeyPair, error)
public EcsKeyPair(string name, EcsKeyPairArgs? args = null, CustomResourceOptions? opts = null)
public EcsKeyPair(String name, EcsKeyPairArgs args)
public EcsKeyPair(String name, EcsKeyPairArgs args, CustomResourceOptions options)
type: alicloud:ecs:EcsKeyPair
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EcsKeyPairArgs
- 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 EcsKeyPairArgs
- 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 EcsKeyPairArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EcsKeyPairArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EcsKeyPairArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
EcsKeyPair 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 EcsKeyPair resource accepts the following input properties:
- Key
File string The key file.
- Key
Name string Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- Key
Name stringPrefix - Key
Pair stringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- Public
Key string You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- Resource
Group stringId The Id of resource group which the key pair belongs.
- Dictionary<string, object>
- Key
File string The key file.
- Key
Name string Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- Key
Name stringPrefix - Key
Pair stringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- Public
Key string You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- Resource
Group stringId The Id of resource group which the key pair belongs.
- map[string]interface{}
- key
File String The key file.
- key
Name String Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- key
Name StringPrefix - key
Pair StringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- public
Key String You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- resource
Group StringId The Id of resource group which the key pair belongs.
- Map<String,Object>
- key
File string The key file.
- key
Name string Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- key
Name stringPrefix - key
Pair stringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- public
Key string You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- resource
Group stringId The Id of resource group which the key pair belongs.
- {[key: string]: any}
- key_
file str The key file.
- key_
name str Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- key_
name_ strprefix - key_
pair_ strname The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- public_
key str You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- resource_
group_ strid The Id of resource group which the key pair belongs.
- Mapping[str, Any]
- key
File String The key file.
- key
Name String Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- key
Name StringPrefix - key
Pair StringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- public
Key String You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- resource
Group StringId The Id of resource group which the key pair belongs.
- Map<Any>
Outputs
All input properties are implicitly available as output properties. Additionally, the EcsKeyPair resource produces the following output properties:
- Finger
Print string The finger print of the key pair.
- Id string
The provider-assigned unique ID for this managed resource.
- Finger
Print string The finger print of the key pair.
- Id string
The provider-assigned unique ID for this managed resource.
- finger
Print String The finger print of the key pair.
- id String
The provider-assigned unique ID for this managed resource.
- finger
Print string The finger print of the key pair.
- id string
The provider-assigned unique ID for this managed resource.
- finger_
print str The finger print of the key pair.
- id str
The provider-assigned unique ID for this managed resource.
- finger
Print String The finger print of the key pair.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing EcsKeyPair Resource
Get an existing EcsKeyPair 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?: EcsKeyPairState, opts?: CustomResourceOptions): EcsKeyPair
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
finger_print: Optional[str] = None,
key_file: Optional[str] = None,
key_name: Optional[str] = None,
key_name_prefix: Optional[str] = None,
key_pair_name: Optional[str] = None,
public_key: Optional[str] = None,
resource_group_id: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None) -> EcsKeyPair
func GetEcsKeyPair(ctx *Context, name string, id IDInput, state *EcsKeyPairState, opts ...ResourceOption) (*EcsKeyPair, error)
public static EcsKeyPair Get(string name, Input<string> id, EcsKeyPairState? state, CustomResourceOptions? opts = null)
public static EcsKeyPair get(String name, Output<String> id, EcsKeyPairState 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.
- Finger
Print string The finger print of the key pair.
- Key
File string The key file.
- Key
Name string Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- Key
Name stringPrefix - Key
Pair stringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- Public
Key string You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- Resource
Group stringId The Id of resource group which the key pair belongs.
- Dictionary<string, object>
- Finger
Print string The finger print of the key pair.
- Key
File string The key file.
- Key
Name string Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- Key
Name stringPrefix - Key
Pair stringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- Public
Key string You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- Resource
Group stringId The Id of resource group which the key pair belongs.
- map[string]interface{}
- finger
Print String The finger print of the key pair.
- key
File String The key file.
- key
Name String Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- key
Name StringPrefix - key
Pair StringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- public
Key String You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- resource
Group StringId The Id of resource group which the key pair belongs.
- Map<String,Object>
- finger
Print string The finger print of the key pair.
- key
File string The key file.
- key
Name string Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- key
Name stringPrefix - key
Pair stringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- public
Key string You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- resource
Group stringId The Id of resource group which the key pair belongs.
- {[key: string]: any}
- finger_
print str The finger print of the key pair.
- key_
file str The key file.
- key_
name str Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- key_
name_ strprefix - key_
pair_ strname The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- public_
key str You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- resource_
group_ strid The Id of resource group which the key pair belongs.
- Mapping[str, Any]
- finger
Print String The finger print of the key pair.
- key
File String The key file.
- key
Name String Field
key_name
has been deprecated from provider version 1.121.0. New fieldkey_pair_name
instead.Field 'key_name' has been deprecated from provider version 1.121.0. New field 'key_pair_name' instead.
- key
Name StringPrefix - key
Pair StringName The key pair's name. It is the only in one Alicloud account, the key pair's name. must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
- public
Key String You can import an existing public key and using Alicloud key pair to manage it. If this parameter is specified,
resource_group_id
is the key pair belongs.- resource
Group StringId The Id of resource group which the key pair belongs.
- Map<Any>
Import
ECS Key Pair can be imported using the id, e.g.
$ pulumi import alicloud:ecs/ecsKeyPair:EcsKeyPair example <key_name>
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.