konnect.Cmek
Explore with Pulumi AI
Cmek Resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";
const myCmek = new konnect.Cmek("myCmek", {
description: "My Key Description",
cmekId: "default",
keyArn: "arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012",
});
import pulumi
import pulumi_konnect as konnect
my_cmek = konnect.Cmek("myCmek",
description="My Key Description",
cmek_id="default",
key_arn="arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/konnect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := konnect.NewCmek(ctx, "myCmek", &konnect.CmekArgs{
Description: pulumi.String("My Key Description"),
CmekId: pulumi.String("default"),
KeyArn: pulumi.String("arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;
return await Deployment.RunAsync(() =>
{
var myCmek = new Konnect.Cmek("myCmek", new()
{
Description = "My Key Description",
CmekId = "default",
KeyArn = "arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.Cmek;
import com.pulumi.konnect.CmekArgs;
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 myCmek = new Cmek("myCmek", CmekArgs.builder()
.description("My Key Description")
.cmekId("default")
.keyArn("arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012")
.build());
}
}
resources:
myCmek:
type: konnect:Cmek
properties:
description: My Key Description
cmekId: default
keyArn: arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012
Create Cmek Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cmek(name: string, args: CmekArgs, opts?: CustomResourceOptions);
@overload
def Cmek(resource_name: str,
args: CmekArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cmek(resource_name: str,
opts: Optional[ResourceOptions] = None,
key_arn: Optional[str] = None,
cmek_id: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None)
func NewCmek(ctx *Context, name string, args CmekArgs, opts ...ResourceOption) (*Cmek, error)
public Cmek(string name, CmekArgs args, CustomResourceOptions? opts = null)
type: konnect:Cmek
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 CmekArgs
- 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 CmekArgs
- 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 CmekArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CmekArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CmekArgs
- 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 cmekResource = new Konnect.Cmek("cmekResource", new()
{
KeyArn = "string",
CmekId = "string",
Description = "string",
Name = "string",
});
example, err := konnect.NewCmek(ctx, "cmekResource", &konnect.CmekArgs{
KeyArn: pulumi.String("string"),
CmekId: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
var cmekResource = new Cmek("cmekResource", CmekArgs.builder()
.keyArn("string")
.cmekId("string")
.description("string")
.name("string")
.build());
cmek_resource = konnect.Cmek("cmekResource",
key_arn="string",
cmek_id="string",
description="string",
name="string")
const cmekResource = new konnect.Cmek("cmekResource", {
keyArn: "string",
cmekId: "string",
description: "string",
name: "string",
});
type: konnect:Cmek
properties:
cmekId: string
description: string
keyArn: string
name: string
Cmek 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 Cmek resource accepts the following input properties:
- Key
Arn string - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- Cmek
Id string - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- Description string
- An optional description of the CMEK.
- Name string
- The name of the CMEK. We recommend you match the key's name used in KMS.
- Key
Arn string - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- Cmek
Id string - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- Description string
- An optional description of the CMEK.
- Name string
- The name of the CMEK. We recommend you match the key's name used in KMS.
- key
Arn String - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- cmek
Id String - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- description String
- An optional description of the CMEK.
- name String
- The name of the CMEK. We recommend you match the key's name used in KMS.
- key
Arn string - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- cmek
Id string - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- description string
- An optional description of the CMEK.
- name string
- The name of the CMEK. We recommend you match the key's name used in KMS.
- key_
arn str - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- cmek_
id str - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- description str
- An optional description of the CMEK.
- name str
- The name of the CMEK. We recommend you match the key's name used in KMS.
- key
Arn String - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- cmek
Id String - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- description String
- An optional description of the CMEK.
- name String
- The name of the CMEK. We recommend you match the key's name used in KMS.
Outputs
All input properties are implicitly available as output properties. Additionally, the Cmek resource produces the following output properties:
- created_
at str - An ISO-8601 timestamp representation of entity creation date.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - An ISO-8601 timestamp representation of entity update date.
Look up Existing Cmek Resource
Get an existing Cmek 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?: CmekState, opts?: CustomResourceOptions): Cmek
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cmek_id: Optional[str] = None,
created_at: Optional[str] = None,
description: Optional[str] = None,
key_arn: Optional[str] = None,
name: Optional[str] = None,
updated_at: Optional[str] = None) -> Cmek
func GetCmek(ctx *Context, name string, id IDInput, state *CmekState, opts ...ResourceOption) (*Cmek, error)
public static Cmek Get(string name, Input<string> id, CmekState? state, CustomResourceOptions? opts = null)
public static Cmek get(String name, Output<String> id, CmekState state, CustomResourceOptions options)
resources: _: type: konnect:Cmek 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.
- Cmek
Id string - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- Created
At string - An ISO-8601 timestamp representation of entity creation date.
- Description string
- An optional description of the CMEK.
- Key
Arn string - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- Name string
- The name of the CMEK. We recommend you match the key's name used in KMS.
- Updated
At string - An ISO-8601 timestamp representation of entity update date.
- Cmek
Id string - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- Created
At string - An ISO-8601 timestamp representation of entity creation date.
- Description string
- An optional description of the CMEK.
- Key
Arn string - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- Name string
- The name of the CMEK. We recommend you match the key's name used in KMS.
- Updated
At string - An ISO-8601 timestamp representation of entity update date.
- cmek
Id String - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- created
At String - An ISO-8601 timestamp representation of entity creation date.
- description String
- An optional description of the CMEK.
- key
Arn String - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- name String
- The name of the CMEK. We recommend you match the key's name used in KMS.
- updated
At String - An ISO-8601 timestamp representation of entity update date.
- cmek
Id string - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- created
At string - An ISO-8601 timestamp representation of entity creation date.
- description string
- An optional description of the CMEK.
- key
Arn string - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- name string
- The name of the CMEK. We recommend you match the key's name used in KMS.
- updated
At string - An ISO-8601 timestamp representation of entity update date.
- cmek_
id str - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- created_
at str - An ISO-8601 timestamp representation of entity creation date.
- description str
- An optional description of the CMEK.
- key_
arn str - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- name str
- The name of the CMEK. We recommend you match the key's name used in KMS.
- updated_
at str - An ISO-8601 timestamp representation of entity update date.
- cmek
Id String - Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints. Default: "default"; must be "default"
- created
At String - An ISO-8601 timestamp representation of entity creation date.
- description String
- An optional description of the CMEK.
- key
Arn String - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
- name String
- The name of the CMEK. We recommend you match the key's name used in KMS.
- updated
At String - An ISO-8601 timestamp representation of entity update date.
Import
$ pulumi import konnect:index/cmek:Cmek my_konnect_cmek "default"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnect
Terraform Provider.