AWS Native v0.63.0, May 25 23

aws-native.kms.getReplicaKey

Explore with Pulumi AI

The AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).

Using getReplicaKey

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getReplicaKey(args: GetReplicaKeyArgs, opts?: InvokeOptions): Promise<GetReplicaKeyResult>
function getReplicaKeyOutput(args: GetReplicaKeyOutputArgs, opts?: InvokeOptions): Output<GetReplicaKeyResult>

def get_replica_key(key_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetReplicaKeyResult
def get_replica_key_output(key_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetReplicaKeyResult]

func LookupReplicaKey(ctx *Context, args *LookupReplicaKeyArgs, opts ...InvokeOption) (*LookupReplicaKeyResult, error)
func LookupReplicaKeyOutput(ctx *Context, args *LookupReplicaKeyOutputArgs, opts ...InvokeOption) LookupReplicaKeyResultOutput

> Note: This function is named LookupReplicaKey in the Go SDK.

public static class GetReplicaKey 
{
    public static Task<GetReplicaKeyResult> InvokeAsync(GetReplicaKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicaKeyResult> Invoke(GetReplicaKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetReplicaKeyResult> getReplicaKey(GetReplicaKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:kms:getReplicaKey
  arguments:
    # arguments dictionary

The following arguments are supported:

KeyId string

KeyId string

keyId String

keyId string

key_id str

keyId String

getReplicaKey Result

The following output properties are available:

Arn string
Description string: A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
Enabled bool: Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
KeyId string
KeyPolicy object: The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
Tags List<Pulumi.AwsNative.KMS.Outputs.ReplicaKeyTag>: An array of key-value pairs to apply to this resource.

Arn string
Description string: A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
Enabled bool: Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
KeyId string
KeyPolicy interface{}: The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
Tags []ReplicaKeyTag: An array of key-value pairs to apply to this resource.

arn String
description String: A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
enabled Boolean: Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
keyId String
keyPolicy Object: The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
tags List<ReplicaKeyTag>: An array of key-value pairs to apply to this resource.

arn string
description string: A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
enabled boolean: Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
keyId string
keyPolicy any: The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
tags ReplicaKeyTag[]: An array of key-value pairs to apply to this resource.

arn str
description str: A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
enabled bool: Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
key_id str
key_policy Any: The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
tags Sequence[ReplicaKeyTag]: An array of key-value pairs to apply to this resource.

arn String
description String: A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
enabled Boolean: Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
keyId String
keyPolicy Any: The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
tags List<Property Map>: An array of key-value pairs to apply to this resource.

Supporting Types

ReplicaKeyTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0