Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. kms
  5. getReplicaKey

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.kms.getReplicaKey

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    Search the CloudFormation User Guide for AWS::KMS::ReplicaKey for more information about the expected schema for this property.

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    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.

    Search the CloudFormation User Guide for AWS::KMS::ReplicaKey for more information about the expected schema for this property.

    Tags Tag
    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.

    Search the CloudFormation User Guide for AWS::KMS::ReplicaKey for more information about the expected schema for this property.

    tags List<Tag>
    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.

    Search the CloudFormation User Guide for AWS::KMS::ReplicaKey for more information about the expected schema for this property.

    tags Tag[]
    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.

    Search the CloudFormation User Guide for AWS::KMS::ReplicaKey for more information about the expected schema for this property.

    tags Sequence[root_Tag]
    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.

    Search the CloudFormation User Guide for AWS::KMS::ReplicaKey for more information about the expected schema for this property.

    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native