Class: Aws::Types::KeyMetadata

Inherits:

Object

Object
Aws::Types::KeyMetadata

show all

Defined in:: sig/types.rbs

Constant Summary collapse

SENSITIVE = Returns: ([])

Instance Attribute Summary collapse

#arn ⇒ ::String
Returns the value of attribute arn.
#aws_account_id ⇒ ::String
Returns the value of attribute aws_account_id.
#cloud_hsm_cluster_id ⇒ ::String
Returns the value of attribute cloud_hsm_cluster_id.
#creation_date ⇒ ::Time
Returns the value of attribute creation_date.
#current_key_material_id ⇒ ::String
Returns the value of attribute current_key_material_id.
#custom_key_store_id ⇒ ::String
Returns the value of attribute custom_key_store_id.
#customer_master_key_spec ⇒ "RSA_2048", ...
Returns the value of attribute customer_master_key_spec.
#deletion_date ⇒ ::Time
Returns the value of attribute deletion_date.
#description ⇒ ::String
Returns the value of attribute description.
#enabled ⇒ Boolean
Returns the value of attribute enabled.
#encryption_algorithms ⇒ ::Array[("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")]
Returns the value of attribute encryption_algorithms.
#expiration_model ⇒ "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
Returns the value of attribute expiration_model.
#key_agreement_algorithms ⇒ ::Array[("ECDH")]
Returns the value of attribute key_agreement_algorithms.
#key_id ⇒ ::String
Returns the value of attribute key_id.
#key_manager ⇒ "AWS", "CUSTOMER"
Returns the value of attribute key_manager.
#key_spec ⇒ "RSA_2048", ...
Returns the value of attribute key_spec.
#key_state ⇒ "Creating", ...
Returns the value of attribute key_state.
#key_usage ⇒ "SIGN_VERIFY", ...
Returns the value of attribute key_usage.
#mac_algorithms ⇒ ::Array[("HMAC_SHA_224" | "HMAC_SHA_256" | "HMAC_SHA_384" | "HMAC_SHA_512")]
Returns the value of attribute mac_algorithms.
#multi_region ⇒ Boolean
Returns the value of attribute multi_region.
#multi_region_configuration ⇒ Types::MultiRegionConfiguration
Returns the value of attribute multi_region_configuration.
#origin ⇒ "AWS_KMS", ...
Returns the value of attribute origin.
#pending_deletion_window_in_days ⇒ ::Integer
Returns the value of attribute pending_deletion_window_in_days.
#signing_algorithms ⇒ ::Array[("RSASSA_PSS_SHA_256" | "RSASSA_PSS_SHA_384" | "RSASSA_PSS_SHA_512" | "RSASSA_PKCS1_V1_5_SHA_256" | "RSASSA_PKCS1_V1_5_SHA_384" | "RSASSA_PKCS1_V1_5_SHA_512" | "ECDSA_SHA_256" | "ECDSA_SHA_384" | "ECDSA_SHA_512" | "SM2DSA" | "ML_DSA_SHAKE_256" | "ED25519_SHA_512" | "ED25519_PH_SHA_512")]
Returns the value of attribute signing_algorithms.
#valid_to ⇒ ::Time
Returns the value of attribute valid_to.
#xks_key_configuration ⇒ Types::XksKeyConfigurationType
Returns the value of attribute xks_key_configuration.

Instance Attribute Details

#arn ⇒ `::String`

Returns the value of attribute arn.

Returns:

(::String)



638
639
640

# File 'sig/types.rbs', line 638

def arn
  @arn
end

#aws_account_id ⇒ `::String`

Returns the value of attribute aws_account_id.

Returns:

(::String)



636
637
638

# File 'sig/types.rbs', line 636

def aws_account_id
  @aws_account_id
end

#cloud_hsm_cluster_id ⇒ `::String`

Returns the value of attribute cloud_hsm_cluster_id.

Returns:

(::String)



648
649
650

# File 'sig/types.rbs', line 648

def cloud_hsm_cluster_id
  @cloud_hsm_cluster_id
end

#creation_date ⇒ `::Time`

Returns the value of attribute creation_date.

Returns:

(::Time)



639
640
641

# File 'sig/types.rbs', line 639

def creation_date
  @creation_date
end

#current_key_material_id ⇒ `::String`

Returns the value of attribute current_key_material_id.

Returns:

(::String)



661
662
663

# File 'sig/types.rbs', line 661

def current_key_material_id
  @current_key_material_id
end

#custom_key_store_id ⇒ `::String`

Returns the value of attribute custom_key_store_id.

Returns:

(::String)



647
648
649

# File 'sig/types.rbs', line 647

def custom_key_store_id
  @custom_key_store_id
end

#customer_master_key_spec ⇒ `"RSA_2048"`, ...

Returns the value of attribute customer_master_key_spec.

Returns:

("RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2")



651
652
653

# File 'sig/types.rbs', line 651

def customer_master_key_spec
  @customer_master_key_spec
end

#deletion_date ⇒ `::Time`

Returns the value of attribute deletion_date.

Returns:

(::Time)



644
645
646

# File 'sig/types.rbs', line 644

def deletion_date
  @deletion_date
end

#description ⇒ `::String`

Returns the value of attribute description.

Returns:

(::String)



641
642
643

# File 'sig/types.rbs', line 641

def description
  @description
end

#enabled ⇒ `Boolean`

Returns the value of attribute enabled.

Returns:

(Boolean)



640
641
642

# File 'sig/types.rbs', line 640

def enabled
  @enabled
end

#encryption_algorithms ⇒ `::Array[("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")]`

Returns the value of attribute encryption_algorithms.

Returns:

(::Array[("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")])



653
654
655

# File 'sig/types.rbs', line 653

def encryption_algorithms
  @encryption_algorithms
end

#expiration_model ⇒ `"KEY_MATERIAL_EXPIRES"`, `"KEY_MATERIAL_DOES_NOT_EXPIRE"`

Returns the value of attribute expiration_model.

Returns:

("KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE")



649
650
651

# File 'sig/types.rbs', line 649

def expiration_model
  @expiration_model
end

#key_agreement_algorithms ⇒ `::Array[("ECDH")]`

Returns the value of attribute key_agreement_algorithms.

Returns:

(::Array[("ECDH")])



655
656
657

# File 'sig/types.rbs', line 655

def key_agreement_algorithms
  @key_agreement_algorithms
end

#key_id ⇒ `::String`

Returns the value of attribute key_id.

Returns:

(::String)



637
638
639

# File 'sig/types.rbs', line 637

def key_id
  @key_id
end

#key_manager ⇒ `"AWS"`, `"CUSTOMER"`

Returns the value of attribute key_manager.

Returns:

("AWS", "CUSTOMER")



650
651
652

# File 'sig/types.rbs', line 650

def key_manager
  @key_manager
end

#key_spec ⇒ `"RSA_2048"`, ...

Returns the value of attribute key_spec.

Returns:

("RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2", "ML_DSA_44", "ML_DSA_65", "ML_DSA_87", "ECC_NIST_EDWARDS25519")



652
653
654

# File 'sig/types.rbs', line 652

def key_spec
  @key_spec
end

#key_state ⇒ `"Creating"`, ...

Returns the value of attribute key_state.

Returns:

("Creating", "Enabled", "Disabled", "PendingDeletion", "PendingImport", "PendingReplicaDeletion", "Unavailable", "Updating")



643
644
645

# File 'sig/types.rbs', line 643

def key_state
  @key_state
end

#key_usage ⇒ `"SIGN_VERIFY"`, ...

Returns the value of attribute key_usage.

Returns:

("SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC", "KEY_AGREEMENT")



642
643
644

# File 'sig/types.rbs', line 642

def key_usage
  @key_usage
end

#mac_algorithms ⇒ `::Array[("HMAC_SHA_224" | "HMAC_SHA_256" | "HMAC_SHA_384" | "HMAC_SHA_512")]`

Returns the value of attribute mac_algorithms.

Returns:

(::Array[("HMAC_SHA_224" | "HMAC_SHA_256" | "HMAC_SHA_384" | "HMAC_SHA_512")])



659
660
661

# File 'sig/types.rbs', line 659

def mac_algorithms
  @mac_algorithms
end

#multi_region ⇒ `Boolean`

Returns the value of attribute multi_region.

Returns:

(Boolean)



656
657
658

# File 'sig/types.rbs', line 656

def multi_region
  @multi_region
end

#multi_region_configuration ⇒ `Types::MultiRegionConfiguration`

Returns the value of attribute multi_region_configuration.

Returns:

(Types::MultiRegionConfiguration)



657
658
659

# File 'sig/types.rbs', line 657

def multi_region_configuration
  @multi_region_configuration
end

#origin ⇒ `"AWS_KMS"`, ...

Returns the value of attribute origin.

Returns:

("AWS_KMS", "EXTERNAL", "AWS_CLOUDHSM", "EXTERNAL_KEY_STORE")



646
647
648

# File 'sig/types.rbs', line 646

def origin
  @origin
end

#pending_deletion_window_in_days ⇒ `::Integer`

Returns the value of attribute pending_deletion_window_in_days.

Returns:

(::Integer)



658
659
660

# File 'sig/types.rbs', line 658

def pending_deletion_window_in_days
  @pending_deletion_window_in_days
end

#signing_algorithms ⇒ `::Array[("RSASSA_PSS_SHA_256" | "RSASSA_PSS_SHA_384" | "RSASSA_PSS_SHA_512" | "RSASSA_PKCS1_V1_5_SHA_256" | "RSASSA_PKCS1_V1_5_SHA_384" | "RSASSA_PKCS1_V1_5_SHA_512" | "ECDSA_SHA_256" | "ECDSA_SHA_384" | "ECDSA_SHA_512" | "SM2DSA" | "ML_DSA_SHAKE_256" | "ED25519_SHA_512" | "ED25519_PH_SHA_512")]`

Returns the value of attribute signing_algorithms.

Returns:

(::Array[("RSASSA_PSS_SHA_256" | "RSASSA_PSS_SHA_384" | "RSASSA_PSS_SHA_512" | "RSASSA_PKCS1_V1_5_SHA_256" | "RSASSA_PKCS1_V1_5_SHA_384" | "RSASSA_PKCS1_V1_5_SHA_512" | "ECDSA_SHA_256" | "ECDSA_SHA_384" | "ECDSA_SHA_512" | "SM2DSA" | "ML_DSA_SHAKE_256" | "ED25519_SHA_512" | "ED25519_PH_SHA_512")])



654
655
656

# File 'sig/types.rbs', line 654

def signing_algorithms
  @signing_algorithms
end

#valid_to ⇒ `::Time`

Returns the value of attribute valid_to.

Returns:

(::Time)



645
646
647

# File 'sig/types.rbs', line 645

def valid_to
  @valid_to
end

#xks_key_configuration ⇒ `Types::XksKeyConfigurationType`

Returns the value of attribute xks_key_configuration.

Returns:

(Types::XksKeyConfigurationType)



660
661
662

# File 'sig/types.rbs', line 660

def xks_key_configuration
  @xks_key_configuration
end

Class: Aws::Types::KeyMetadata

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ ::String

#aws_account_id ⇒ ::String

#cloud_hsm_cluster_id ⇒ ::String

#creation_date ⇒ ::Time

#current_key_material_id ⇒ ::String

#custom_key_store_id ⇒ ::String

#customer_master_key_spec ⇒ "RSA_2048", ...

#deletion_date ⇒ ::Time

#description ⇒ ::String

#enabled ⇒ Boolean

#encryption_algorithms ⇒ ::Array[("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")]

#expiration_model ⇒ "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"

#key_agreement_algorithms ⇒ ::Array[("ECDH")]

#key_id ⇒ ::String

#key_manager ⇒ "AWS", "CUSTOMER"

#key_spec ⇒ "RSA_2048", ...

#key_state ⇒ "Creating", ...

#key_usage ⇒ "SIGN_VERIFY", ...

#mac_algorithms ⇒ ::Array[("HMAC_SHA_224" | "HMAC_SHA_256" | "HMAC_SHA_384" | "HMAC_SHA_512")]

#multi_region ⇒ Boolean

#multi_region_configuration ⇒ Types::MultiRegionConfiguration

#origin ⇒ "AWS_KMS", ...

#pending_deletion_window_in_days ⇒ ::Integer

#valid_to ⇒ ::Time

#xks_key_configuration ⇒ Types::XksKeyConfigurationType

#arn ⇒ `::String`

#aws_account_id ⇒ `::String`

#cloud_hsm_cluster_id ⇒ `::String`

#creation_date ⇒ `::Time`

#current_key_material_id ⇒ `::String`

#custom_key_store_id ⇒ `::String`

#customer_master_key_spec ⇒ `"RSA_2048"`, ...

#deletion_date ⇒ `::Time`

#description ⇒ `::String`

#enabled ⇒ `Boolean`

#encryption_algorithms ⇒ `::Array[("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")]`

#expiration_model ⇒ `"KEY_MATERIAL_EXPIRES"`, `"KEY_MATERIAL_DOES_NOT_EXPIRE"`

#key_agreement_algorithms ⇒ `::Array[("ECDH")]`

#key_id ⇒ `::String`

#key_manager ⇒ `"AWS"`, `"CUSTOMER"`

#key_spec ⇒ `"RSA_2048"`, ...

#key_state ⇒ `"Creating"`, ...

#key_usage ⇒ `"SIGN_VERIFY"`, ...

#mac_algorithms ⇒ `::Array[("HMAC_SHA_224" | "HMAC_SHA_256" | "HMAC_SHA_384" | "HMAC_SHA_512")]`

#multi_region ⇒ `Boolean`

#multi_region_configuration ⇒ `Types::MultiRegionConfiguration`

#origin ⇒ `"AWS_KMS"`, ...

#pending_deletion_window_in_days ⇒ `::Integer`

#valid_to ⇒ `::Time`

#xks_key_configuration ⇒ `Types::XksKeyConfigurationType`