Class CfnAliasProps

Properties for defining a CfnAlias.

Inheritance

object

CfnAliasProps

Implements

ICfnAliasProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.KMS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAliasProps : ICfnAliasProps

Syntax (vb)

Public Class CfnAliasProps Implements ICfnAliasProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.KMS;

             var cfnAliasProps = new CfnAliasProps {
                 AliasName = "aliasName",
                 TargetKeyId = "targetKeyId"
             };

Synopsis

Constructors

CfnAliasProps()

Properties for defining a CfnAlias.

Properties

AliasName	Specifies the alias name. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias` .
TargetKeyId	Associates the alias with the specified customer managed key . The KMS key must be in the same AWS account and Region.

Constructors

CfnAliasProps()

Properties for defining a CfnAlias.

public CfnAliasProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.KMS;

             var cfnAliasProps = new CfnAliasProps {
                 AliasName = "aliasName",
                 TargetKeyId = "targetKeyId"
             };

Properties

AliasName

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias .

public string AliasName { get; set; }

Property Value

string

Remarks

If you change the value of the <code>AliasName</code> property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).

The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/ . The alias/aws/ prefix is reserved for AWS managed keys .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-aliasname

TargetKeyId

Associates the alias with the specified customer managed key . The KMS key must be in the same AWS account and Region.

public string TargetKeyId { get; set; }

Property Value

string

Remarks

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the key ID and ARN in the AWS Key Management Service Developer Guide .

Specify the key ID or the key ARN of the KMS key.

For example:

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-targetkeyid

Implements

ICfnAliasProps