/AWS1/CL_PCYKEYSUMMARY¶
Metadata about an Amazon Web Services Payment Cryptography key.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_keyarn TYPE /AWS1/PCYKEYARN /AWS1/PCYKEYARN¶
The Amazon Resource Name (ARN) of the key.
iv_keystate TYPE /AWS1/PCYKEYSTATE /AWS1/PCYKEYSTATE¶
The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
io_keyattributes TYPE REF TO /AWS1/CL_PCYKEYATTRIBUTES /AWS1/CL_PCYKEYATTRIBUTES¶
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.
iv_keycheckvalue TYPE /AWS1/PCYKEYCHECKVALUE /AWS1/PCYKEYCHECKVALUE¶
The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
iv_exportable TYPE /AWS1/PCYBOOLEAN /AWS1/PCYBOOLEAN¶
Specifies whether the key is exportable. This data is immutable after the key is created.
iv_enabled TYPE /AWS1/PCYBOOLEAN /AWS1/PCYBOOLEAN¶
Specifies whether the key is enabled.
Optional arguments:¶
iv_multiregionkeytype TYPE /AWS1/PCYMULTIREGIONKEYTYPE /AWS1/PCYMULTIREGIONKEYTYPE¶
Indicates whether this key is a Multi-Region key and its role in the Multi-Region key hierarchy.
Multi-Region replication keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a Primary Region key (PRK) (which can be replicated to other Amazon Web Services Regions) or a Replica Region key (RRK) (which is a copy of a PRK in another Region). For more information, see Multi-Region key replication.
iv_primaryregion TYPE /AWS1/PCYREGION /AWS1/PCYREGION¶
PrimaryRegion
Queryable Attributes¶
KeyArn¶
The Amazon Resource Name (ARN) of the key.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYARN() |
Getter for KEYARN, with configurable default |
ASK_KEYARN() |
Getter for KEYARN w/ exceptions if field has no value |
HAS_KEYARN() |
Determine if KEYARN has a value |
KeyState¶
The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYSTATE() |
Getter for KEYSTATE, with configurable default |
ASK_KEYSTATE() |
Getter for KEYSTATE w/ exceptions if field has no value |
HAS_KEYSTATE() |
Determine if KEYSTATE has a value |
KeyAttributes¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYATTRIBUTES() |
Getter for KEYATTRIBUTES |
KeyCheckValue¶
The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYCHECKVALUE() |
Getter for KEYCHECKVALUE, with configurable default |
ASK_KEYCHECKVALUE() |
Getter for KEYCHECKVALUE w/ exceptions if field has no value |
HAS_KEYCHECKVALUE() |
Determine if KEYCHECKVALUE has a value |
Exportable¶
Specifies whether the key is exportable. This data is immutable after the key is created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPORTABLE() |
Getter for EXPORTABLE, with configurable default |
ASK_EXPORTABLE() |
Getter for EXPORTABLE w/ exceptions if field has no value |
HAS_EXPORTABLE() |
Determine if EXPORTABLE has a value |
Enabled¶
Specifies whether the key is enabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLED() |
Getter for ENABLED, with configurable default |
ASK_ENABLED() |
Getter for ENABLED w/ exceptions if field has no value |
HAS_ENABLED() |
Determine if ENABLED has a value |
MultiRegionKeyType¶
Indicates whether this key is a Multi-Region key and its role in the Multi-Region key hierarchy.
Multi-Region replication keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a Primary Region key (PRK) (which can be replicated to other Amazon Web Services Regions) or a Replica Region key (RRK) (which is a copy of a PRK in another Region). For more information, see Multi-Region key replication.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MULTIREGIONKEYTYPE() |
Getter for MULTIREGIONKEYTYPE, with configurable default |
ASK_MULTIREGIONKEYTYPE() |
Getter for MULTIREGIONKEYTYPE w/ exceptions if field has no |
HAS_MULTIREGIONKEYTYPE() |
Determine if MULTIREGIONKEYTYPE has a value |
PrimaryRegion¶
PrimaryRegion
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIMARYREGION() |
Getter for PRIMARYREGION, with configurable default |
ASK_PRIMARYREGION() |
Getter for PRIMARYREGION w/ exceptions if field has no value |
HAS_PRIMARYREGION() |
Determine if PRIMARYREGION has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_KEYSUMMARYLIST¶
TYPES TT_KEYSUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_PCYKEYSUMMARY WITH DEFAULT KEY
.