1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. SsmSshKeyPairSecret
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.SsmSshKeyPairSecret

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Provides a resource to create a ssm ssh key pair secret

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const exampleKmsKey = new tencentcloud.KmsKey("exampleKmsKey", {
        alias: "tf-example-kms-key",
        description: "example of kms key",
        keyRotationEnabled: false,
        isEnabled: true,
        tags: {
            createdBy: "terraform",
        },
    });
    const exampleSsmSshKeyPairSecret = new tencentcloud.SsmSshKeyPairSecret("exampleSsmSshKeyPairSecret", {
        secretName: "tf-example",
        projectId: 0,
        description: "desc.",
        kmsKeyId: exampleKmsKey.kmsKeyId,
        sshKeyName: "tf_example_ssh",
        status: "Enabled",
        cleanSshKey: true,
        tags: {
            createdBy: "terraform",
        },
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    example_kms_key = tencentcloud.KmsKey("exampleKmsKey",
        alias="tf-example-kms-key",
        description="example of kms key",
        key_rotation_enabled=False,
        is_enabled=True,
        tags={
            "createdBy": "terraform",
        })
    example_ssm_ssh_key_pair_secret = tencentcloud.SsmSshKeyPairSecret("exampleSsmSshKeyPairSecret",
        secret_name="tf-example",
        project_id=0,
        description="desc.",
        kms_key_id=example_kms_key.kms_key_id,
        ssh_key_name="tf_example_ssh",
        status="Enabled",
        clean_ssh_key=True,
        tags={
            "createdBy": "terraform",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleKmsKey, err := tencentcloud.NewKmsKey(ctx, "exampleKmsKey", &tencentcloud.KmsKeyArgs{
    			Alias:              pulumi.String("tf-example-kms-key"),
    			Description:        pulumi.String("example of kms key"),
    			KeyRotationEnabled: pulumi.Bool(false),
    			IsEnabled:          pulumi.Bool(true),
    			Tags: pulumi.StringMap{
    				"createdBy": pulumi.String("terraform"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = tencentcloud.NewSsmSshKeyPairSecret(ctx, "exampleSsmSshKeyPairSecret", &tencentcloud.SsmSshKeyPairSecretArgs{
    			SecretName:  pulumi.String("tf-example"),
    			ProjectId:   pulumi.Float64(0),
    			Description: pulumi.String("desc."),
    			KmsKeyId:    exampleKmsKey.KmsKeyId,
    			SshKeyName:  pulumi.String("tf_example_ssh"),
    			Status:      pulumi.String("Enabled"),
    			CleanSshKey: pulumi.Bool(true),
    			Tags: pulumi.StringMap{
    				"createdBy": pulumi.String("terraform"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Tencentcloud = Pulumi.Tencentcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleKmsKey = new Tencentcloud.KmsKey("exampleKmsKey", new()
        {
            Alias = "tf-example-kms-key",
            Description = "example of kms key",
            KeyRotationEnabled = false,
            IsEnabled = true,
            Tags = 
            {
                { "createdBy", "terraform" },
            },
        });
    
        var exampleSsmSshKeyPairSecret = new Tencentcloud.SsmSshKeyPairSecret("exampleSsmSshKeyPairSecret", new()
        {
            SecretName = "tf-example",
            ProjectId = 0,
            Description = "desc.",
            KmsKeyId = exampleKmsKey.KmsKeyId,
            SshKeyName = "tf_example_ssh",
            Status = "Enabled",
            CleanSshKey = true,
            Tags = 
            {
                { "createdBy", "terraform" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.KmsKey;
    import com.pulumi.tencentcloud.KmsKeyArgs;
    import com.pulumi.tencentcloud.SsmSshKeyPairSecret;
    import com.pulumi.tencentcloud.SsmSshKeyPairSecretArgs;
    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 exampleKmsKey = new KmsKey("exampleKmsKey", KmsKeyArgs.builder()
                .alias("tf-example-kms-key")
                .description("example of kms key")
                .keyRotationEnabled(false)
                .isEnabled(true)
                .tags(Map.of("createdBy", "terraform"))
                .build());
    
            var exampleSsmSshKeyPairSecret = new SsmSshKeyPairSecret("exampleSsmSshKeyPairSecret", SsmSshKeyPairSecretArgs.builder()
                .secretName("tf-example")
                .projectId(0)
                .description("desc.")
                .kmsKeyId(exampleKmsKey.kmsKeyId())
                .sshKeyName("tf_example_ssh")
                .status("Enabled")
                .cleanSshKey(true)
                .tags(Map.of("createdBy", "terraform"))
                .build());
    
        }
    }
    
    resources:
      exampleKmsKey:
        type: tencentcloud:KmsKey
        properties:
          alias: tf-example-kms-key
          description: example of kms key
          keyRotationEnabled: false
          isEnabled: true
          tags:
            createdBy: terraform
      exampleSsmSshKeyPairSecret:
        type: tencentcloud:SsmSshKeyPairSecret
        properties:
          secretName: tf-example
          projectId: 0
          description: desc.
          kmsKeyId: ${exampleKmsKey.kmsKeyId}
          sshKeyName: tf_example_ssh
          status: Enabled
          cleanSshKey: true
          tags:
            createdBy: terraform
    

    Create SsmSshKeyPairSecret Resource

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

    Constructor syntax

    new SsmSshKeyPairSecret(name: string, args: SsmSshKeyPairSecretArgs, opts?: CustomResourceOptions);
    @overload
    def SsmSshKeyPairSecret(resource_name: str,
                            args: SsmSshKeyPairSecretArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def SsmSshKeyPairSecret(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            project_id: Optional[float] = None,
                            secret_name: Optional[str] = None,
                            clean_ssh_key: Optional[bool] = None,
                            description: Optional[str] = None,
                            kms_key_id: Optional[str] = None,
                            ssh_key_name: Optional[str] = None,
                            ssm_ssh_key_pair_secret_id: Optional[str] = None,
                            status: Optional[str] = None,
                            tags: Optional[Mapping[str, str]] = None)
    func NewSsmSshKeyPairSecret(ctx *Context, name string, args SsmSshKeyPairSecretArgs, opts ...ResourceOption) (*SsmSshKeyPairSecret, error)
    public SsmSshKeyPairSecret(string name, SsmSshKeyPairSecretArgs args, CustomResourceOptions? opts = null)
    public SsmSshKeyPairSecret(String name, SsmSshKeyPairSecretArgs args)
    public SsmSshKeyPairSecret(String name, SsmSshKeyPairSecretArgs args, CustomResourceOptions options)
    
    type: tencentcloud:SsmSshKeyPairSecret
    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 SsmSshKeyPairSecretArgs
    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 SsmSshKeyPairSecretArgs
    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 SsmSshKeyPairSecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SsmSshKeyPairSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SsmSshKeyPairSecretArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SsmSshKeyPairSecret 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 SsmSshKeyPairSecret resource accepts the following input properties:

    ProjectId double
    ID of the project to which the created SSH key belongs.
    SecretName string
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    CleanSshKey bool
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    Description string
    Description, such as what it is used for. It contains up to 2,048 bytes.
    KmsKeyId string
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    SshKeyName string
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    SsmSshKeyPairSecretId string
    ID of the resource.
    Status string
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    Tags Dictionary<string, string>
    Tags of secret.
    ProjectId float64
    ID of the project to which the created SSH key belongs.
    SecretName string
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    CleanSshKey bool
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    Description string
    Description, such as what it is used for. It contains up to 2,048 bytes.
    KmsKeyId string
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    SshKeyName string
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    SsmSshKeyPairSecretId string
    ID of the resource.
    Status string
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    Tags map[string]string
    Tags of secret.
    projectId Double
    ID of the project to which the created SSH key belongs.
    secretName String
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    cleanSshKey Boolean
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    description String
    Description, such as what it is used for. It contains up to 2,048 bytes.
    kmsKeyId String
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    sshKeyName String
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    ssmSshKeyPairSecretId String
    ID of the resource.
    status String
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    tags Map<String,String>
    Tags of secret.
    projectId number
    ID of the project to which the created SSH key belongs.
    secretName string
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    cleanSshKey boolean
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    description string
    Description, such as what it is used for. It contains up to 2,048 bytes.
    kmsKeyId string
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    sshKeyName string
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    ssmSshKeyPairSecretId string
    ID of the resource.
    status string
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    tags {[key: string]: string}
    Tags of secret.
    project_id float
    ID of the project to which the created SSH key belongs.
    secret_name str
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    clean_ssh_key bool
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    description str
    Description, such as what it is used for. It contains up to 2,048 bytes.
    kms_key_id str
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    ssh_key_name str
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    ssm_ssh_key_pair_secret_id str
    ID of the resource.
    status str
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    tags Mapping[str, str]
    Tags of secret.
    projectId Number
    ID of the project to which the created SSH key belongs.
    secretName String
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    cleanSshKey Boolean
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    description String
    Description, such as what it is used for. It contains up to 2,048 bytes.
    kmsKeyId String
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    sshKeyName String
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    ssmSshKeyPairSecretId String
    ID of the resource.
    status String
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    tags Map<String>
    Tags of secret.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SsmSshKeyPairSecret resource produces the following output properties:

    CreateTime double
    Credential creation time in UNIX timestamp format.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretType double
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    CreateTime float64
    Credential creation time in UNIX timestamp format.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretType float64
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    createTime Double
    Credential creation time in UNIX timestamp format.
    id String
    The provider-assigned unique ID for this managed resource.
    secretType Double
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    createTime number
    Credential creation time in UNIX timestamp format.
    id string
    The provider-assigned unique ID for this managed resource.
    secretType number
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    create_time float
    Credential creation time in UNIX timestamp format.
    id str
    The provider-assigned unique ID for this managed resource.
    secret_type float
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    createTime Number
    Credential creation time in UNIX timestamp format.
    id String
    The provider-assigned unique ID for this managed resource.
    secretType Number
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.

    Look up Existing SsmSshKeyPairSecret Resource

    Get an existing SsmSshKeyPairSecret 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?: SsmSshKeyPairSecretState, opts?: CustomResourceOptions): SsmSshKeyPairSecret
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            clean_ssh_key: Optional[bool] = None,
            create_time: Optional[float] = None,
            description: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            project_id: Optional[float] = None,
            secret_name: Optional[str] = None,
            secret_type: Optional[float] = None,
            ssh_key_name: Optional[str] = None,
            ssm_ssh_key_pair_secret_id: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> SsmSshKeyPairSecret
    func GetSsmSshKeyPairSecret(ctx *Context, name string, id IDInput, state *SsmSshKeyPairSecretState, opts ...ResourceOption) (*SsmSshKeyPairSecret, error)
    public static SsmSshKeyPairSecret Get(string name, Input<string> id, SsmSshKeyPairSecretState? state, CustomResourceOptions? opts = null)
    public static SsmSshKeyPairSecret get(String name, Output<String> id, SsmSshKeyPairSecretState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:SsmSshKeyPairSecret    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:
    CleanSshKey bool
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    CreateTime double
    Credential creation time in UNIX timestamp format.
    Description string
    Description, such as what it is used for. It contains up to 2,048 bytes.
    KmsKeyId string
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    ProjectId double
    ID of the project to which the created SSH key belongs.
    SecretName string
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    SecretType double
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    SshKeyName string
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    SsmSshKeyPairSecretId string
    ID of the resource.
    Status string
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    Tags Dictionary<string, string>
    Tags of secret.
    CleanSshKey bool
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    CreateTime float64
    Credential creation time in UNIX timestamp format.
    Description string
    Description, such as what it is used for. It contains up to 2,048 bytes.
    KmsKeyId string
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    ProjectId float64
    ID of the project to which the created SSH key belongs.
    SecretName string
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    SecretType float64
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    SshKeyName string
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    SsmSshKeyPairSecretId string
    ID of the resource.
    Status string
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    Tags map[string]string
    Tags of secret.
    cleanSshKey Boolean
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    createTime Double
    Credential creation time in UNIX timestamp format.
    description String
    Description, such as what it is used for. It contains up to 2,048 bytes.
    kmsKeyId String
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    projectId Double
    ID of the project to which the created SSH key belongs.
    secretName String
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    secretType Double
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    sshKeyName String
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    ssmSshKeyPairSecretId String
    ID of the resource.
    status String
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    tags Map<String,String>
    Tags of secret.
    cleanSshKey boolean
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    createTime number
    Credential creation time in UNIX timestamp format.
    description string
    Description, such as what it is used for. It contains up to 2,048 bytes.
    kmsKeyId string
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    projectId number
    ID of the project to which the created SSH key belongs.
    secretName string
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    secretType number
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    sshKeyName string
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    ssmSshKeyPairSecretId string
    ID of the resource.
    status string
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    tags {[key: string]: string}
    Tags of secret.
    clean_ssh_key bool
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    create_time float
    Credential creation time in UNIX timestamp format.
    description str
    Description, such as what it is used for. It contains up to 2,048 bytes.
    kms_key_id str
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    project_id float
    ID of the project to which the created SSH key belongs.
    secret_name str
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    secret_type float
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    ssh_key_name str
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    ssm_ssh_key_pair_secret_id str
    ID of the resource.
    status str
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    tags Mapping[str, str]
    Tags of secret.
    cleanSshKey Boolean
    Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: True: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False: only deletes the SSH key information in the secret.
    createTime Number
    Credential creation time in UNIX timestamp format.
    description String
    Description, such as what it is used for. It contains up to 2,048 bytes.
    kmsKeyId String
    Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption.
    projectId Number
    ID of the project to which the created SSH key belongs.
    secretName String
    Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
    secretType Number
    0: user-defined secret. 1: Tencent Cloud services secret. 2: SSH key secret. 3: Tencent Cloud API key secret. Note: this field may return null, indicating that no valid values can be obtained.
    sshKeyName String
    Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
    ssmSshKeyPairSecretId String
    ID of the resource.
    status String
    Enable or Disable Secret. Valid values is Enabled or Disabled. Default is Enabled.
    tags Map<String>
    Tags of secret.

    Import

    ssm ssh_key_pair_secret can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/ssmSshKeyPairSecret:SsmSshKeyPairSecret ssh_key_pair_secret ssh_key_pair_secret_name
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack