Interface ConnectionPasswordEncryption.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ConnectionPasswordEncryption.Builder,
,ConnectionPasswordEncryption> SdkBuilder<ConnectionPasswordEncryption.Builder,
,ConnectionPasswordEncryption> SdkPojo
- Enclosing class:
ConnectionPasswordEncryption
-
Method Summary
Modifier and TypeMethodDescriptionawsKmsKeyId
(String awsKmsKeyId) An KMS key that is used to encrypt the connection password.returnConnectionPasswordEncrypted
(Boolean returnConnectionPasswordEncrypted) When theReturnConnectionPasswordEncrypted
flag is set to "true", passwords remain encrypted in the responses ofGetConnection
andGetConnections
.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
returnConnectionPasswordEncrypted
ConnectionPasswordEncryption.Builder returnConnectionPasswordEncrypted(Boolean returnConnectionPasswordEncrypted) When the
ReturnConnectionPasswordEncrypted
flag is set to "true", passwords remain encrypted in the responses ofGetConnection
andGetConnections
. This encryption takes effect independently from catalog encryption.- Parameters:
returnConnectionPasswordEncrypted
- When theReturnConnectionPasswordEncrypted
flag is set to "true", passwords remain encrypted in the responses ofGetConnection
andGetConnections
. This encryption takes effect independently from catalog encryption.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awsKmsKeyId
An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of
CreateConnection
andUpdateConnection
needs at leastkms:Encrypt
permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
- Parameters:
awsKmsKeyId
- An KMS key that is used to encrypt the connection password.If connection password protection is enabled, the caller of
CreateConnection
andUpdateConnection
needs at leastkms:Encrypt
permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-