opentelekomcloud.KmsKeyV1
Explore with Pulumi AI
Up-to-date reference of API arguments for KMS key you can get at documentation portal
Manages a V1 KMS key resource within OpenTelekomCloud.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const key1 = new opentelekomcloud.KmsKeyV1("key1", {
isEnabled: true,
keyAlias: "key_1",
keyDescription: "first test key",
pendingDays: "7",
realm: "eu-de-01",
tags: {
muh: "kuh",
},
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
key1 = opentelekomcloud.KmsKeyV1("key1",
is_enabled=True,
key_alias="key_1",
key_description="first test key",
pending_days="7",
realm="eu-de-01",
tags={
"muh": "kuh",
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := opentelekomcloud.NewKmsKeyV1(ctx, "key1", &opentelekomcloud.KmsKeyV1Args{
IsEnabled: pulumi.Bool(true),
KeyAlias: pulumi.String("key_1"),
KeyDescription: pulumi.String("first test key"),
PendingDays: pulumi.String("7"),
Realm: pulumi.String("eu-de-01"),
Tags: pulumi.StringMap{
"muh": pulumi.String("kuh"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var key1 = new Opentelekomcloud.KmsKeyV1("key1", new()
{
IsEnabled = true,
KeyAlias = "key_1",
KeyDescription = "first test key",
PendingDays = "7",
Realm = "eu-de-01",
Tags =
{
{ "muh", "kuh" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.KmsKeyV1;
import com.pulumi.opentelekomcloud.KmsKeyV1Args;
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 key1 = new KmsKeyV1("key1", KmsKeyV1Args.builder()
.isEnabled(true)
.keyAlias("key_1")
.keyDescription("first test key")
.pendingDays("7")
.realm("eu-de-01")
.tags(Map.of("muh", "kuh"))
.build());
}
}
resources:
key1:
type: opentelekomcloud:KmsKeyV1
properties:
isEnabled: true
keyAlias: key_1
keyDescription: first test key
pendingDays: '7'
realm: eu-de-01
tags:
muh: kuh
Create KmsKeyV1 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KmsKeyV1(name: string, args: KmsKeyV1Args, opts?: CustomResourceOptions);
@overload
def KmsKeyV1(resource_name: str,
args: KmsKeyV1Args,
opts: Optional[ResourceOptions] = None)
@overload
def KmsKeyV1(resource_name: str,
opts: Optional[ResourceOptions] = None,
key_alias: Optional[str] = None,
allow_cancel_deletion: Optional[bool] = None,
is_enabled: Optional[bool] = None,
key_description: Optional[str] = None,
kms_key_v1_id: Optional[str] = None,
origin: Optional[str] = None,
pending_days: Optional[str] = None,
realm: Optional[str] = None,
rotation_enabled: Optional[bool] = None,
rotation_interval: Optional[float] = None,
tags: Optional[Mapping[str, str]] = None)
func NewKmsKeyV1(ctx *Context, name string, args KmsKeyV1Args, opts ...ResourceOption) (*KmsKeyV1, error)
public KmsKeyV1(string name, KmsKeyV1Args args, CustomResourceOptions? opts = null)
public KmsKeyV1(String name, KmsKeyV1Args args)
public KmsKeyV1(String name, KmsKeyV1Args args, CustomResourceOptions options)
type: opentelekomcloud:KmsKeyV1
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 KmsKeyV1Args
- 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 KmsKeyV1Args
- 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 KmsKeyV1Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KmsKeyV1Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KmsKeyV1Args
- 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 kmsKeyV1Resource = new Opentelekomcloud.KmsKeyV1("kmsKeyV1Resource", new()
{
KeyAlias = "string",
AllowCancelDeletion = false,
IsEnabled = false,
KeyDescription = "string",
KmsKeyV1Id = "string",
Origin = "string",
PendingDays = "string",
Realm = "string",
RotationEnabled = false,
RotationInterval = 0,
Tags =
{
{ "string", "string" },
},
});
example, err := opentelekomcloud.NewKmsKeyV1(ctx, "kmsKeyV1Resource", &opentelekomcloud.KmsKeyV1Args{
KeyAlias: pulumi.String("string"),
AllowCancelDeletion: pulumi.Bool(false),
IsEnabled: pulumi.Bool(false),
KeyDescription: pulumi.String("string"),
KmsKeyV1Id: pulumi.String("string"),
Origin: pulumi.String("string"),
PendingDays: pulumi.String("string"),
Realm: pulumi.String("string"),
RotationEnabled: pulumi.Bool(false),
RotationInterval: pulumi.Float64(0),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var kmsKeyV1Resource = new KmsKeyV1("kmsKeyV1Resource", KmsKeyV1Args.builder()
.keyAlias("string")
.allowCancelDeletion(false)
.isEnabled(false)
.keyDescription("string")
.kmsKeyV1Id("string")
.origin("string")
.pendingDays("string")
.realm("string")
.rotationEnabled(false)
.rotationInterval(0)
.tags(Map.of("string", "string"))
.build());
kms_key_v1_resource = opentelekomcloud.KmsKeyV1("kmsKeyV1Resource",
key_alias="string",
allow_cancel_deletion=False,
is_enabled=False,
key_description="string",
kms_key_v1_id="string",
origin="string",
pending_days="string",
realm="string",
rotation_enabled=False,
rotation_interval=0,
tags={
"string": "string",
})
const kmsKeyV1Resource = new opentelekomcloud.KmsKeyV1("kmsKeyV1Resource", {
keyAlias: "string",
allowCancelDeletion: false,
isEnabled: false,
keyDescription: "string",
kmsKeyV1Id: "string",
origin: "string",
pendingDays: "string",
realm: "string",
rotationEnabled: false,
rotationInterval: 0,
tags: {
string: "string",
},
});
type: opentelekomcloud:KmsKeyV1
properties:
allowCancelDeletion: false
isEnabled: false
keyAlias: string
keyDescription: string
kmsKeyV1Id: string
origin: string
pendingDays: string
realm: string
rotationEnabled: false
rotationInterval: 0
tags:
string: string
KmsKeyV1 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 KmsKeyV1 resource accepts the following input properties:
- Key
Alias string - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- Allow
Cancel boolDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - Is
Enabled bool - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- Key
Description string - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- Kms
Key stringV1Id - The globally unique identifier for the key.
- Origin string
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- Pending
Days string - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- Realm string
- Region where a key resides. Changing this creates a new key.
- Rotation
Enabled bool - Specifies whether the key is enabled for rotation.
- Rotation
Interval double - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- Dictionary<string, string>
- Tags key/value pairs to associate with the AutoScaling Group.
- Key
Alias string - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- Allow
Cancel boolDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - Is
Enabled bool - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- Key
Description string - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- Kms
Key stringV1Id - The globally unique identifier for the key.
- Origin string
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- Pending
Days string - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- Realm string
- Region where a key resides. Changing this creates a new key.
- Rotation
Enabled bool - Specifies whether the key is enabled for rotation.
- Rotation
Interval float64 - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- map[string]string
- Tags key/value pairs to associate with the AutoScaling Group.
- key
Alias String - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- allow
Cancel BooleanDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - is
Enabled Boolean - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- key
Description String - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- kms
Key StringV1Id - The globally unique identifier for the key.
- origin String
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- pending
Days String - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- realm String
- Region where a key resides. Changing this creates a new key.
- rotation
Enabled Boolean - Specifies whether the key is enabled for rotation.
- rotation
Interval Double - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- Map<String,String>
- Tags key/value pairs to associate with the AutoScaling Group.
- key
Alias string - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- allow
Cancel booleanDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - is
Enabled boolean - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- key
Description string - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- kms
Key stringV1Id - The globally unique identifier for the key.
- origin string
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- pending
Days string - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- realm string
- Region where a key resides. Changing this creates a new key.
- rotation
Enabled boolean - Specifies whether the key is enabled for rotation.
- rotation
Interval number - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- {[key: string]: string}
- Tags key/value pairs to associate with the AutoScaling Group.
- key_
alias str - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- allow_
cancel_ booldeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - is_
enabled bool - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- key_
description str - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- kms_
key_ strv1_ id - The globally unique identifier for the key.
- origin str
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- pending_
days str - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- realm str
- Region where a key resides. Changing this creates a new key.
- rotation_
enabled bool - Specifies whether the key is enabled for rotation.
- rotation_
interval float - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- Mapping[str, str]
- Tags key/value pairs to associate with the AutoScaling Group.
- key
Alias String - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- allow
Cancel BooleanDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - is
Enabled Boolean - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- key
Description String - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- kms
Key StringV1Id - The globally unique identifier for the key.
- origin String
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- pending
Days String - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- realm String
- Region where a key resides. Changing this creates a new key.
- rotation
Enabled Boolean - Specifies whether the key is enabled for rotation.
- rotation
Interval Number - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- Map<String>
- Tags key/value pairs to associate with the AutoScaling Group.
Outputs
All input properties are implicitly available as output properties. Additionally, the KmsKeyV1 resource produces the following output properties:
- Creation
Date string - Creation time (time stamp) of a key.
- Default
Key stringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - Domain
Id string - ID of a user domain for the key.
- Expiration
Time string - Expiration time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Key
State string - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- Rotation
Number double - Number of key rotations.
- Scheduled
Deletion stringDate - Scheduled deletion time (time stamp) of a key.
- Creation
Date string - Creation time (time stamp) of a key.
- Default
Key stringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - Domain
Id string - ID of a user domain for the key.
- Expiration
Time string - Expiration time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Key
State string - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- Rotation
Number float64 - Number of key rotations.
- Scheduled
Deletion stringDate - Scheduled deletion time (time stamp) of a key.
- creation
Date String - Creation time (time stamp) of a key.
- default
Key StringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - domain
Id String - ID of a user domain for the key.
- expiration
Time String - Expiration time.
- id String
- The provider-assigned unique ID for this managed resource.
- key
State String - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- rotation
Number Double - Number of key rotations.
- scheduled
Deletion StringDate - Scheduled deletion time (time stamp) of a key.
- creation
Date string - Creation time (time stamp) of a key.
- default
Key stringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - domain
Id string - ID of a user domain for the key.
- expiration
Time string - Expiration time.
- id string
- The provider-assigned unique ID for this managed resource.
- key
State string - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- rotation
Number number - Number of key rotations.
- scheduled
Deletion stringDate - Scheduled deletion time (time stamp) of a key.
- creation_
date str - Creation time (time stamp) of a key.
- default_
key_ strflag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - domain_
id str - ID of a user domain for the key.
- expiration_
time str - Expiration time.
- id str
- The provider-assigned unique ID for this managed resource.
- key_
state str - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- rotation_
number float - Number of key rotations.
- scheduled_
deletion_ strdate - Scheduled deletion time (time stamp) of a key.
- creation
Date String - Creation time (time stamp) of a key.
- default
Key StringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - domain
Id String - ID of a user domain for the key.
- expiration
Time String - Expiration time.
- id String
- The provider-assigned unique ID for this managed resource.
- key
State String - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- rotation
Number Number - Number of key rotations.
- scheduled
Deletion StringDate - Scheduled deletion time (time stamp) of a key.
Look up Existing KmsKeyV1 Resource
Get an existing KmsKeyV1 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?: KmsKeyV1State, opts?: CustomResourceOptions): KmsKeyV1
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_cancel_deletion: Optional[bool] = None,
creation_date: Optional[str] = None,
default_key_flag: Optional[str] = None,
domain_id: Optional[str] = None,
expiration_time: Optional[str] = None,
is_enabled: Optional[bool] = None,
key_alias: Optional[str] = None,
key_description: Optional[str] = None,
key_state: Optional[str] = None,
kms_key_v1_id: Optional[str] = None,
origin: Optional[str] = None,
pending_days: Optional[str] = None,
realm: Optional[str] = None,
rotation_enabled: Optional[bool] = None,
rotation_interval: Optional[float] = None,
rotation_number: Optional[float] = None,
scheduled_deletion_date: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None) -> KmsKeyV1
func GetKmsKeyV1(ctx *Context, name string, id IDInput, state *KmsKeyV1State, opts ...ResourceOption) (*KmsKeyV1, error)
public static KmsKeyV1 Get(string name, Input<string> id, KmsKeyV1State? state, CustomResourceOptions? opts = null)
public static KmsKeyV1 get(String name, Output<String> id, KmsKeyV1State state, CustomResourceOptions options)
resources: _: type: opentelekomcloud:KmsKeyV1 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.
- Allow
Cancel boolDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - Creation
Date string - Creation time (time stamp) of a key.
- Default
Key stringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - Domain
Id string - ID of a user domain for the key.
- Expiration
Time string - Expiration time.
- Is
Enabled bool - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- Key
Alias string - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- Key
Description string - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- Key
State string - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- Kms
Key stringV1Id - The globally unique identifier for the key.
- Origin string
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- Pending
Days string - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- Realm string
- Region where a key resides. Changing this creates a new key.
- Rotation
Enabled bool - Specifies whether the key is enabled for rotation.
- Rotation
Interval double - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- Rotation
Number double - Number of key rotations.
- Scheduled
Deletion stringDate - Scheduled deletion time (time stamp) of a key.
- Dictionary<string, string>
- Tags key/value pairs to associate with the AutoScaling Group.
- Allow
Cancel boolDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - Creation
Date string - Creation time (time stamp) of a key.
- Default
Key stringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - Domain
Id string - ID of a user domain for the key.
- Expiration
Time string - Expiration time.
- Is
Enabled bool - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- Key
Alias string - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- Key
Description string - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- Key
State string - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- Kms
Key stringV1Id - The globally unique identifier for the key.
- Origin string
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- Pending
Days string - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- Realm string
- Region where a key resides. Changing this creates a new key.
- Rotation
Enabled bool - Specifies whether the key is enabled for rotation.
- Rotation
Interval float64 - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- Rotation
Number float64 - Number of key rotations.
- Scheduled
Deletion stringDate - Scheduled deletion time (time stamp) of a key.
- map[string]string
- Tags key/value pairs to associate with the AutoScaling Group.
- allow
Cancel BooleanDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - creation
Date String - Creation time (time stamp) of a key.
- default
Key StringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - domain
Id String - ID of a user domain for the key.
- expiration
Time String - Expiration time.
- is
Enabled Boolean - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- key
Alias String - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- key
Description String - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- key
State String - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- kms
Key StringV1Id - The globally unique identifier for the key.
- origin String
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- pending
Days String - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- realm String
- Region where a key resides. Changing this creates a new key.
- rotation
Enabled Boolean - Specifies whether the key is enabled for rotation.
- rotation
Interval Double - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- rotation
Number Double - Number of key rotations.
- scheduled
Deletion StringDate - Scheduled deletion time (time stamp) of a key.
- Map<String,String>
- Tags key/value pairs to associate with the AutoScaling Group.
- allow
Cancel booleanDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - creation
Date string - Creation time (time stamp) of a key.
- default
Key stringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - domain
Id string - ID of a user domain for the key.
- expiration
Time string - Expiration time.
- is
Enabled boolean - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- key
Alias string - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- key
Description string - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- key
State string - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- kms
Key stringV1Id - The globally unique identifier for the key.
- origin string
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- pending
Days string - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- realm string
- Region where a key resides. Changing this creates a new key.
- rotation
Enabled boolean - Specifies whether the key is enabled for rotation.
- rotation
Interval number - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- rotation
Number number - Number of key rotations.
- scheduled
Deletion stringDate - Scheduled deletion time (time stamp) of a key.
- {[key: string]: string}
- Tags key/value pairs to associate with the AutoScaling Group.
- allow_
cancel_ booldeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - creation_
date str - Creation time (time stamp) of a key.
- default_
key_ strflag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - domain_
id str - ID of a user domain for the key.
- expiration_
time str - Expiration time.
- is_
enabled bool - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- key_
alias str - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- key_
description str - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- key_
state str - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- kms_
key_ strv1_ id - The globally unique identifier for the key.
- origin str
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- pending_
days str - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- realm str
- Region where a key resides. Changing this creates a new key.
- rotation_
enabled bool - Specifies whether the key is enabled for rotation.
- rotation_
interval float - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- rotation_
number float - Number of key rotations.
- scheduled_
deletion_ strdate - Scheduled deletion time (time stamp) of a key.
- Mapping[str, str]
- Tags key/value pairs to associate with the AutoScaling Group.
- allow
Cancel BooleanDeletion - Specifies whether the key is enabled from Pending Deletion state. The value
true
indicates that the key state Pending Deletion will be cancelled. - creation
Date String - Creation time (time stamp) of a key.
- default
Key StringFlag - Identification of a Master Key. The value
1
indicates a Default Master Key, and the value0
indicates a key. - domain
Id String - ID of a user domain for the key.
- expiration
Time String - Expiration time.
- is
Enabled Boolean - Specifies whether the KMS key is enabled. The default value is true. This parameter is not supported when creating an external import key for the first time.
- key
Alias String - The alias in which to create the key. It is required when we create a new key. Changing this updates the alias of key.
- key
Description String - The description of the key as viewed in OpenTelekomCloud console. Changing this updates the description of key.
- key
State String - The current status of the KMS key.
The valid values are as follows:
- 1: To be activated.
- 2: Enabled.
- 3: Disabled.
- 4: Pending deletion.
- 5: Pending import.
- kms
Key StringV1Id - The globally unique identifier for the key.
- origin String
- Specifies the source of the KMS key.
Changing this parameter will create a new resource.
The default value is kms. The valid values are as follows:
- kms: The key is generated by KMS.
- external: The key is external imported.
- pending
Days String - Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 1096 days. Defaults to 7. It only is used when delete a key.
- realm String
- Region where a key resides. Changing this creates a new key.
- rotation
Enabled Boolean - Specifies whether the key is enabled for rotation.
- rotation
Interval Number - Rotation interval. The value is an integer ranging from 30 to 365. Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.
- rotation
Number Number - Number of key rotations.
- scheduled
Deletion StringDate - Scheduled deletion time (time stamp) of a key.
- Map<String>
- Tags key/value pairs to associate with the AutoScaling Group.
Import
KMS Keys can be imported using the id
, e.g.
$ pulumi import opentelekomcloud:index/kmsKeyV1:KmsKeyV1 key_1 7056d636-ac60-4663-8a6c-82d3c32c1c64
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
- License
- Notes
- This Pulumi package is based on the
opentelekomcloud
Terraform Provider.