Class KeyProps.Jsii$Proxy
- All Implemented Interfaces:
KeyProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- KeyProps
KeyProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kms.KeyProps
KeyProps.Builder, KeyProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(KeyProps.Builder builder) Constructor that initializes the object based on literal property values passed by theKeyProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final List<IPrincipal>
A list of principals to add as key administrators to the key policy.final String
getAlias()
Initial alias to add to the key.final String
A description of the key.final Boolean
Indicates whether the key is available for use.final Boolean
Indicates whether AWS KMS rotates the key.final KeySpec
The cryptographic configuration of the key.final KeyUsage
The cryptographic operations for which the key can be used.final Boolean
Creates a multi-Region primary key that you can replicate in other AWS Regions.final Duration
Specifies the number of days in the waiting period before AWS KMS deletes a CMK that has been removed from a CloudFormation stack.final PolicyDocument
Custom policy document to attach to the KMS key.final RemovalPolicy
Whether the encryption key should be retained when it is removed from the Stack.final Duration
The period between each automatic rotation.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theKeyProps.Builder
.
-
-
Method Details
-
getAdmins
Description copied from interface:KeyProps
A list of principals to add as key administrators to the key policy.Key administrators have permissions to manage the key (e.g., change permissions, revoke), but do not have permissions to use the key in cryptographic operations (e.g., encrypt, decrypt).
These principals will be added to the default key policy (if none specified), or to the specified policy (if provided).
Default: []
-
getAlias
Description copied from interface:KeyProps
Initial alias to add to the key.More aliases can be added later by calling
addAlias
.Default: - No alias is added for the key.
-
getDescription
Description copied from interface:KeyProps
A description of the key.Use a description that helps your users decide whether the key is appropriate for a particular task.
Default: - No description.
- Specified by:
getDescription
in interfaceKeyProps
-
getEnabled
Description copied from interface:KeyProps
Indicates whether the key is available for use.Default: - Key is enabled.
- Specified by:
getEnabled
in interfaceKeyProps
-
getEnableKeyRotation
Description copied from interface:KeyProps
Indicates whether AWS KMS rotates the key.Default: false
- Specified by:
getEnableKeyRotation
in interfaceKeyProps
-
getKeySpec
Description copied from interface:KeyProps
The cryptographic configuration of the key. The valid value depends on usage of the key.IMPORTANT: If you change this property of an existing key, the existing key is scheduled for deletion and a new key is created with the specified value.
Default: KeySpec.SYMMETRIC_DEFAULT
- Specified by:
getKeySpec
in interfaceKeyProps
-
getKeyUsage
Description copied from interface:KeyProps
The cryptographic operations for which the key can be used.IMPORTANT: If you change this property of an existing key, the existing key is scheduled for deletion and a new key is created with the specified value.
Default: KeyUsage.ENCRYPT_DECRYPT
- Specified by:
getKeyUsage
in interfaceKeyProps
-
getMultiRegion
Description copied from interface:KeyProps
Creates a multi-Region primary key that you can replicate in other AWS Regions.You can't change the
multiRegion
value after the KMS key is created.IMPORTANT: If you change the value of the
multiRegion
property on an existing KMS key, the update request fails, regardless of the value of the UpdateReplacePolicy attribute. This prevents you from accidentally deleting a KMS key by changing an immutable property value.Default: false
- Specified by:
getMultiRegion
in interfaceKeyProps
- See Also:
-
getPendingWindow
Description copied from interface:KeyProps
Specifies the number of days in the waiting period before AWS KMS deletes a CMK that has been removed from a CloudFormation stack.When you remove a customer master key (CMK) from a CloudFormation stack, AWS KMS schedules the CMK for deletion and starts the mandatory waiting period. The PendingWindowInDays property determines the length of waiting period. During the waiting period, the key state of CMK is Pending Deletion, which prevents the CMK from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the CMK.
Enter a value between 7 and 30 days.
Default: - 30 days
- Specified by:
getPendingWindow
in interfaceKeyProps
- See Also:
-
getPolicy
Description copied from interface:KeyProps
Custom policy document to attach to the KMS key.NOTE - If the
@aws-cdk/aws-kms:defaultKeyPolicies
feature flag is set (the default for new projects), this policy will override the default key policy and become the only key policy for the key. If the feature flag is not set, this policy will be appended to the default key policy.Default: - A policy document with permissions for the account root to administer the key will be created.
-
getRemovalPolicy
Description copied from interface:KeyProps
Whether the encryption key should be retained when it is removed from the Stack.This is useful when one wants to retain access to data that was encrypted with a key that is being retired.
Default: RemovalPolicy.Retain
- Specified by:
getRemovalPolicy
in interfaceKeyProps
-
getRotationPeriod
Description copied from interface:KeyProps
The period between each automatic rotation.Default: - set by CFN to 365 days.
- Specified by:
getRotationPeriod
in interfaceKeyProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-