Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Yandex
  3. API Docs
  4. KmsSymmetricKey
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
pulumi/pulumi-yandex

yandex.KmsSymmetricKey

Explore with Pulumi AI

Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
pulumi/pulumi-yandex

Import

A KMS symmetric key can be imported using the id of the resource, e.g.

 $ pulumi import yandex:index/kmsSymmetricKey:KmsSymmetricKey top-secret kms_key_id
Copy

Create KmsSymmetricKey Resource

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

Constructor syntax

new KmsSymmetricKey(name: string, args?: KmsSymmetricKeyArgs, opts?: CustomResourceOptions);
@overload
def KmsSymmetricKey(resource_name: str,
                    args: Optional[KmsSymmetricKeyArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def KmsSymmetricKey(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    default_algorithm: Optional[str] = None,
                    description: Optional[str] = None,
                    folder_id: Optional[str] = None,
                    labels: Optional[Mapping[str, str]] = None,
                    name: Optional[str] = None,
                    rotation_period: Optional[str] = None)
func NewKmsSymmetricKey(ctx *Context, name string, args *KmsSymmetricKeyArgs, opts ...ResourceOption) (*KmsSymmetricKey, error)
public KmsSymmetricKey(string name, KmsSymmetricKeyArgs? args = null, CustomResourceOptions? opts = null)
public KmsSymmetricKey(String name, KmsSymmetricKeyArgs args)
public KmsSymmetricKey(String name, KmsSymmetricKeyArgs args, CustomResourceOptions options)

type: yandex:KmsSymmetricKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args KmsSymmetricKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args KmsSymmetricKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args KmsSymmetricKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args KmsSymmetricKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KmsSymmetricKeyArgs
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 kmsSymmetricKeyResource = new Yandex.KmsSymmetricKey("kmsSymmetricKeyResource", new()
{
    DefaultAlgorithm = "string",
    Description = "string",
    FolderId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    RotationPeriod = "string",
});
Copy
example, err := yandex.NewKmsSymmetricKey(ctx, "kmsSymmetricKeyResource", &yandex.KmsSymmetricKeyArgs{
	DefaultAlgorithm: pulumi.String("string"),
	Description:      pulumi.String("string"),
	FolderId:         pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:           pulumi.String("string"),
	RotationPeriod: pulumi.String("string"),
})
Copy
var kmsSymmetricKeyResource = new KmsSymmetricKey("kmsSymmetricKeyResource", KmsSymmetricKeyArgs.builder()
    .defaultAlgorithm("string")
    .description("string")
    .folderId("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .rotationPeriod("string")
    .build());
Copy
kms_symmetric_key_resource = yandex.KmsSymmetricKey("kmsSymmetricKeyResource",
    default_algorithm="string",
    description="string",
    folder_id="string",
    labels={
        "string": "string",
    },
    name="string",
    rotation_period="string")
Copy
const kmsSymmetricKeyResource = new yandex.KmsSymmetricKey("kmsSymmetricKeyResource", {
    defaultAlgorithm: "string",
    description: "string",
    folderId: "string",
    labels: {
        string: "string",
    },
    name: "string",
    rotationPeriod: "string",
});
Copy
type: yandex:KmsSymmetricKey
properties:
    defaultAlgorithm: string
    description: string
    folderId: string
    labels:
        string: string
    name: string
    rotationPeriod: string
Copy

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

DefaultAlgorithm string
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
Description string
An optional description of the key.
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the key.
Name string
Name of the key.
RotationPeriod string
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
DefaultAlgorithm string
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
Description string
An optional description of the key.
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Labels map[string]string
A set of key/value label pairs to assign to the key.
Name string
Name of the key.
RotationPeriod string
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
defaultAlgorithm String
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
description String
An optional description of the key.
folderId String
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
labels Map<String,String>
A set of key/value label pairs to assign to the key.
name String
Name of the key.
rotationPeriod String
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
defaultAlgorithm string
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
description string
An optional description of the key.
folderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
labels {[key: string]: string}
A set of key/value label pairs to assign to the key.
name string
Name of the key.
rotationPeriod string
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
default_algorithm str
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
description str
An optional description of the key.
folder_id str
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
labels Mapping[str, str]
A set of key/value label pairs to assign to the key.
name str
Name of the key.
rotation_period str
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
defaultAlgorithm String
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
description String
An optional description of the key.
folderId String
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
labels Map<String>
A set of key/value label pairs to assign to the key.
name String
Name of the key.
rotationPeriod String
Interval between automatic rotations. To disable automatic rotation, omit this parameter.

Outputs

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

CreatedAt string
Creation timestamp of the key.
Id string
The provider-assigned unique ID for this managed resource.
RotatedAt string
Last rotation timestamp of the key.
Status string
The status of the key.
CreatedAt string
Creation timestamp of the key.
Id string
The provider-assigned unique ID for this managed resource.
RotatedAt string
Last rotation timestamp of the key.
Status string
The status of the key.
createdAt String
Creation timestamp of the key.
id String
The provider-assigned unique ID for this managed resource.
rotatedAt String
Last rotation timestamp of the key.
status String
The status of the key.
createdAt string
Creation timestamp of the key.
id string
The provider-assigned unique ID for this managed resource.
rotatedAt string
Last rotation timestamp of the key.
status string
The status of the key.
created_at str
Creation timestamp of the key.
id str
The provider-assigned unique ID for this managed resource.
rotated_at str
Last rotation timestamp of the key.
status str
The status of the key.
createdAt String
Creation timestamp of the key.
id String
The provider-assigned unique ID for this managed resource.
rotatedAt String
Last rotation timestamp of the key.
status String
The status of the key.

Look up Existing KmsSymmetricKey Resource

Get an existing KmsSymmetricKey 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?: KmsSymmetricKeyState, opts?: CustomResourceOptions): KmsSymmetricKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        default_algorithm: Optional[str] = None,
        description: Optional[str] = None,
        folder_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        rotated_at: Optional[str] = None,
        rotation_period: Optional[str] = None,
        status: Optional[str] = None) -> KmsSymmetricKey
func GetKmsSymmetricKey(ctx *Context, name string, id IDInput, state *KmsSymmetricKeyState, opts ...ResourceOption) (*KmsSymmetricKey, error)
public static KmsSymmetricKey Get(string name, Input<string> id, KmsSymmetricKeyState? state, CustomResourceOptions? opts = null)
public static KmsSymmetricKey get(String name, Output<String> id, KmsSymmetricKeyState state, CustomResourceOptions options)
resources:  _:    type: yandex:KmsSymmetricKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreatedAt string
Creation timestamp of the key.
DefaultAlgorithm string
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
Description string
An optional description of the key.
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the key.
Name string
Name of the key.
RotatedAt string
Last rotation timestamp of the key.
RotationPeriod string
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
Status string
The status of the key.
CreatedAt string
Creation timestamp of the key.
DefaultAlgorithm string
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
Description string
An optional description of the key.
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Labels map[string]string
A set of key/value label pairs to assign to the key.
Name string
Name of the key.
RotatedAt string
Last rotation timestamp of the key.
RotationPeriod string
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
Status string
The status of the key.
createdAt String
Creation timestamp of the key.
defaultAlgorithm String
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
description String
An optional description of the key.
folderId String
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
labels Map<String,String>
A set of key/value label pairs to assign to the key.
name String
Name of the key.
rotatedAt String
Last rotation timestamp of the key.
rotationPeriod String
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
status String
The status of the key.
createdAt string
Creation timestamp of the key.
defaultAlgorithm string
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
description string
An optional description of the key.
folderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
labels {[key: string]: string}
A set of key/value label pairs to assign to the key.
name string
Name of the key.
rotatedAt string
Last rotation timestamp of the key.
rotationPeriod string
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
status string
The status of the key.
created_at str
Creation timestamp of the key.
default_algorithm str
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
description str
An optional description of the key.
folder_id str
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
labels Mapping[str, str]
A set of key/value label pairs to assign to the key.
name str
Name of the key.
rotated_at str
Last rotation timestamp of the key.
rotation_period str
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
status str
The status of the key.
createdAt String
Creation timestamp of the key.
defaultAlgorithm String
Encryption algorithm to be used with a new key version, generated with the next rotation. The default value is AES_128.
description String
An optional description of the key.
folderId String
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
labels Map<String>
A set of key/value label pairs to assign to the key.
name String
Name of the key.
rotatedAt String
Last rotation timestamp of the key.
rotationPeriod String
Interval between automatic rotations. To disable automatic rotation, omit this parameter.
status String
The status of the key.

Package Details

Repository
Yandex pulumi/pulumi-yandex
License
Apache-2.0
Notes
This Pulumi package is based on the yandex Terraform Provider.
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
pulumi/pulumi-yandex