Package software.amazon.awscdk.services.paymentcryptography

Interface CfnKey.KeyAttributesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKey.KeyAttributesProperty.Jsii$Proxy

Enclosing class:

CfnKey

@Stability(Stable)
public static interface CfnKey.KeyAttributesProperty
extends software.amazon.jsii.JsiiSerializable

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.

This data is immutable after the key is created.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.paymentcryptography.*;
 KeyAttributesProperty keyAttributesProperty = KeyAttributesProperty.builder()
         .keyAlgorithm("keyAlgorithm")
         .keyClass("keyClass")
         .keyModesOfUse(KeyModesOfUseProperty.builder()
                 .decrypt(false)
                 .deriveKey(false)
                 .encrypt(false)
                 .generate(false)
                 .noRestrictions(false)
                 .sign(false)
                 .unwrap(false)
                 .verify(false)
                 .wrap(false)
                 .build())
         .keyUsage("keyUsage")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKey.KeyAttributesProperty.Builder	A builder for CfnKey.KeyAttributesProperty
static final class	CfnKey.KeyAttributesProperty.Jsii$Proxy	An implementation for CfnKey.KeyAttributesProperty

Method Summary

Modifier and Type	Method	Description
static CfnKey.KeyAttributesProperty.Builder	builder()
String	getKeyAlgorithm()	The key algorithm to be use during creation of an AWS Payment Cryptography key.
String	getKeyClass()	The type of AWS Payment Cryptography key to create, which determines the classification of the cryptographic method and whether AWS Payment Cryptography key contains a symmetric key or an asymmetric key pair.
Object	getKeyModesOfUse()	The list of cryptographic operations that you can perform using the key.
String	getKeyUsage()	The cryptographic usage of an AWS Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKeyAlgorithm

@Stability(Stable)
@NotNull
String getKeyAlgorithm()

The key algorithm to be use during creation of an AWS Payment Cryptography key.

For symmetric keys, AWS Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, AWS Payment Cryptography supports RSA and ECC_NIST algorithms.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html#cfn-paymentcryptography-key-keyattributes-keyalgorithm

getKeyClass

@Stability(Stable)
@NotNull
String getKeyClass()

The type of AWS Payment Cryptography key to create, which determines the classification of the cryptographic method and whether AWS Payment Cryptography key contains a symmetric key or an asymmetric key pair.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html#cfn-paymentcryptography-key-keyattributes-keyclass

getKeyModesOfUse

@Stability(Stable)
@NotNull
Object getKeyModesOfUse()

The list of cryptographic operations that you can perform using the key.

Returns union: either IResolvable or CfnKey.KeyModesOfUseProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html#cfn-paymentcryptography-key-keyattributes-keymodesofuse

getKeyUsage

@Stability(Stable)
@NotNull
String getKeyUsage()

The cryptographic usage of an AWS Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html#cfn-paymentcryptography-key-keyattributes-keyusage

builder

@Stability(Stable)
static CfnKey.KeyAttributesProperty.Builder builder()

Returns:

a CfnKey.KeyAttributesProperty.Builder of CfnKey.KeyAttributesProperty