AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ConnectionPasswordEncryption

import "github.com/aws/aws-sdk-go/service/glue"

type ConnectionPasswordEncryption struct { AwsKmsKeyId *string `min:"1" type:"string"` ReturnConnectionPasswordEncrypted *bool `type:"boolean" required:"true"` }

The data structure used by the Data Catalog to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.

When a CreationConnection request arrives containing a password, the Data Catalog first encrypts the password using your KMS key, and then encrypts the whole connection object again if catalog encryption is also enabled.

This encryption requires that you set KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you may want only admin users to have decrypt permission on the password key.

AwsKmsKeyId

Type: *string

A KMS key used to protect access to the JDBC source.

All users in your account should be granted the kms:encrypt permission to encrypt passwords before storing them in the Data Catalog (through the AWS Glue CreateConnection operation).

The decrypt permission should be granted only to KMS key admins and IAM roles designated for AWS Glue crawlers.

ReturnConnectionPasswordEncrypted

Type: *bool

When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption.

ReturnConnectionPasswordEncrypted is a required field

Method

GoString

func (s ConnectionPasswordEncryption) GoString() string

GoString returns the string representation

SetAwsKmsKeyId

func (s *ConnectionPasswordEncryption) SetAwsKmsKeyId(v string) *ConnectionPasswordEncryption

SetAwsKmsKeyId sets the AwsKmsKeyId field's value.

SetReturnConnectionPasswordEncrypted

func (s *ConnectionPasswordEncryption) SetReturnConnectionPasswordEncrypted(v bool) *ConnectionPasswordEncryption

SetReturnConnectionPasswordEncrypted sets the ReturnConnectionPasswordEncrypted field's value.

String

func (s ConnectionPasswordEncryption) String() string

String returns the string representation

Validate

func (s *ConnectionPasswordEncryption) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: