Skip to content

KeySummary

Source code in docs_src/capo_payment_cryptography/types/key_summary.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class KeySummary(TypedDict, closed=True):
    key_arn: "capo_payment_cryptography.types.key_arn.KeyArn"
    """<p>The Amazon Resource Name (ARN) of the key.</p>"""
    key_state: "capo_payment_cryptography.types.key_state.KeyState"
    """<p>The state of an Amazon Web Services Payment Cryptography that is being created or deleted.</p>"""
    key_attributes: "capo_payment_cryptography.types.key_attributes.KeyAttributes"
    """<p>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.</p>"""
    key_check_value: "capo_payment_cryptography.types.key_check_value.KeyCheckValue"
    """<p>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.</p>"""
    exportable: "bool"
    """<p>Specifies whether the key is exportable. This data is immutable after the key is created.</p>"""
    enabled: "bool"
    """<p>Specifies whether the key is enabled. </p>"""
    multi_region_key_type: NotRequired[
        "capo_payment_cryptography.types.multi_region_key_type.MultiRegionKeyType"
    ]
    """<p>Indicates whether this key is a Multi-Region key and its role in the Multi-Region key hierarchy.</p> <p>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 <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html">Multi-Region key replication</a>.</p>"""
    primary_region: NotRequired["capo_payment_cryptography.types.region.Region"]

enabled instance-attribute 

enabled: bool

Specifies whether the key is enabled.

exportable instance-attribute 

exportable: bool

Specifies whether the key is exportable. This data is immutable after the key is created.

key_arn instance-attribute 

key_arn: KeyArn

The Amazon Resource Name (ARN) of the key.

key_attributes instance-attribute 

key_attributes: 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.

key_check_value instance-attribute 

key_check_value: 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.

key_state instance-attribute 

key_state: KeyState

The state of an Amazon Web Services Payment Cryptography that is being created or deleted.

multi_region_key_type instance-attribute 

multi_region_key_type: NotRequired[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.

primary_region instance-attribute 

primary_region: NotRequired[Region]