Class CfnAlias
Creates an alias , or a friendly name, for an AWS Payment Cryptography key.
Implements
Inherited Members
Namespace: Amazon.CDK.AwsPaymentcryptography
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAlias : CfnResource, IInspectable
Syntax (vb)
Public Class CfnAlias
Inherits CfnResource
Implements IInspectable
Remarks
You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData .
You can associate the alias with any key in the same AWS Region . Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and AWS Region , but you can create another alias with the same name in a different AWS Region .
To change the key that's associated with the alias, call UpdateAlias . To delete the alias, call DeleteAlias . These operations don't affect the underlying key. To get the alias that you created, call ListAliases .
Cross-account use : This operation can't be used across different AWS accounts.
Related operations:
CloudformationResource: AWS::PaymentCryptography::Alias
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_paymentcryptography;
var cfnAlias = new CfnAlias(this, "MyCfnAlias", new CfnAliasProps {
AliasName = "aliasName",
// the properties below are optional
KeyArn = "keyArn"
});
Synopsis
Constructors
CfnAlias(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAlias(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnAlias(Construct, String, ICfnAliasProps) |
Properties
AliasName | A friendly name that you can use to refer to a key. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
KeyArn | The |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAlias(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAlias(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAlias(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAlias(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnAlias(Construct, String, ICfnAliasProps)
public CfnAlias(Construct scope, string id, ICfnAliasProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnAliasProps
Resource properties.
Properties
AliasName
A friendly name that you can use to refer to a key.
public virtual string AliasName { get; set; }
Property Value
System.String
Remarks
The value must begin with alias/
.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
KeyArn
The KeyARN
of the key associated with the alias.
public virtual string KeyArn { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>