AWS Classic v5.41.0, May 15 23

aws.glue.DataCatalogEncryptionSettings

Explore with Pulumi AI

Provides a Glue Data Catalog Encryption Settings resource.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Glue.DataCatalogEncryptionSettings("example", new()
    {
        DataCatalogEncryptionSettingsConfig = new Aws.Glue.Inputs.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs
        {
            ConnectionPasswordEncryption = new Aws.Glue.Inputs.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryptionArgs
            {
                AwsKmsKeyId = aws_kms_key.Test.Arn,
                ReturnConnectionPasswordEncrypted = true,
            },
            EncryptionAtRest = new Aws.Glue.Inputs.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRestArgs
            {
                CatalogEncryptionMode = "SSE-KMS",
                SseAwsKmsKeyId = aws_kms_key.Test.Arn,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glue.NewDataCatalogEncryptionSettings(ctx, "example", &glue.DataCatalogEncryptionSettingsArgs{
			DataCatalogEncryptionSettings: &glue.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs{
				ConnectionPasswordEncryption: &glue.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryptionArgs{
					AwsKmsKeyId:                       pulumi.Any(aws_kms_key.Test.Arn),
					ReturnConnectionPasswordEncrypted: pulumi.Bool(true),
				},
				EncryptionAtRest: &glue.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRestArgs{
					CatalogEncryptionMode: pulumi.String("SSE-KMS"),
					SseAwsKmsKeyId:        pulumi.Any(aws_kms_key.Test.Arn),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.DataCatalogEncryptionSettings;
import com.pulumi.aws.glue.DataCatalogEncryptionSettingsArgs;
import com.pulumi.aws.glue.inputs.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs;
import com.pulumi.aws.glue.inputs.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryptionArgs;
import com.pulumi.aws.glue.inputs.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRestArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DataCatalogEncryptionSettings("example", DataCatalogEncryptionSettingsArgs.builder()        
            .dataCatalogEncryptionSettings(DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs.builder()
                .connectionPasswordEncryption(DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryptionArgs.builder()
                    .awsKmsKeyId(aws_kms_key.test().arn())
                    .returnConnectionPasswordEncrypted(true)
                    .build())
                .encryptionAtRest(DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRestArgs.builder()
                    .catalogEncryptionMode("SSE-KMS")
                    .sseAwsKmsKeyId(aws_kms_key.test().arn())
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.glue.DataCatalogEncryptionSettings("example", data_catalog_encryption_settings=aws.glue.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs(
    connection_password_encryption=aws.glue.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryptionArgs(
        aws_kms_key_id=aws_kms_key["test"]["arn"],
        return_connection_password_encrypted=True,
    ),
    encryption_at_rest=aws.glue.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRestArgs(
        catalog_encryption_mode="SSE-KMS",
        sse_aws_kms_key_id=aws_kms_key["test"]["arn"],
    ),
))

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.DataCatalogEncryptionSettings("example", {dataCatalogEncryptionSettings: {
    connectionPasswordEncryption: {
        awsKmsKeyId: aws_kms_key.test.arn,
        returnConnectionPasswordEncrypted: true,
    },
    encryptionAtRest: {
        catalogEncryptionMode: "SSE-KMS",
        sseAwsKmsKeyId: aws_kms_key.test.arn,
    },
}});

resources:
  example:
    type: aws:glue:DataCatalogEncryptionSettings
    properties:
      dataCatalogEncryptionSettings:
        connectionPasswordEncryption:
          awsKmsKeyId: ${aws_kms_key.test.arn}
          returnConnectionPasswordEncrypted: true
        encryptionAtRest:
          catalogEncryptionMode: SSE-KMS
          sseAwsKmsKeyId: ${aws_kms_key.test.arn}

Create DataCatalogEncryptionSettings Resource

new DataCatalogEncryptionSettings(name: string, args: DataCatalogEncryptionSettingsArgs, opts?: CustomResourceOptions);

@overload
def DataCatalogEncryptionSettings(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  catalog_id: Optional[str] = None,
                                  data_catalog_encryption_settings: Optional[DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs] = None)
@overload
def DataCatalogEncryptionSettings(resource_name: str,
                                  args: DataCatalogEncryptionSettingsArgs,
                                  opts: Optional[ResourceOptions] = None)

func NewDataCatalogEncryptionSettings(ctx *Context, name string, args DataCatalogEncryptionSettingsArgs, opts ...ResourceOption) (*DataCatalogEncryptionSettings, error)

public DataCatalogEncryptionSettings(string name, DataCatalogEncryptionSettingsArgs args, CustomResourceOptions? opts = null)

public DataCatalogEncryptionSettings(String name, DataCatalogEncryptionSettingsArgs args)
public DataCatalogEncryptionSettings(String name, DataCatalogEncryptionSettingsArgs args, CustomResourceOptions options)

type: aws:glue:DataCatalogEncryptionSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DataCatalogEncryptionSettingsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DataCatalogEncryptionSettingsArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DataCatalogEncryptionSettingsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DataCatalogEncryptionSettingsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DataCatalogEncryptionSettingsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

DataCatalogEncryptionSettings Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DataCatalogEncryptionSettings resource accepts the following input properties:

DataCatalogEncryptionSettingsConfig DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.
CatalogId string: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.

DataCatalogEncryptionSettings DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.
CatalogId string: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.

dataCatalogEncryptionSettings DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.
catalogId String: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.

dataCatalogEncryptionSettings DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.
catalogId string: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.

data_catalog_encryption_settings DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.
catalog_id str: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.

dataCatalogEncryptionSettings Property Map: The security configuration to set. see Data Catalog Encryption Settings.
catalogId String: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.

Outputs

All input properties are implicitly available as output properties. Additionally, the DataCatalogEncryptionSettings resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing DataCatalogEncryptionSettings Resource

Get an existing DataCatalogEncryptionSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DataCatalogEncryptionSettingsState, opts?: CustomResourceOptions): DataCatalogEncryptionSettings

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_id: Optional[str] = None,
        data_catalog_encryption_settings: Optional[DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs] = None) -> DataCatalogEncryptionSettings

func GetDataCatalogEncryptionSettings(ctx *Context, name string, id IDInput, state *DataCatalogEncryptionSettingsState, opts ...ResourceOption) (*DataCatalogEncryptionSettings, error)

public static DataCatalogEncryptionSettings Get(string name, Input<string> id, DataCatalogEncryptionSettingsState? state, CustomResourceOptions? opts = null)

public static DataCatalogEncryptionSettings get(String name, Output<String> id, DataCatalogEncryptionSettingsState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CatalogId string: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.
DataCatalogEncryptionSettingsConfig DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.

CatalogId string: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.
DataCatalogEncryptionSettings DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.

catalogId String: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.
dataCatalogEncryptionSettings DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.

catalogId string: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.
dataCatalogEncryptionSettings DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.

catalog_id str: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.
data_catalog_encryption_settings DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsArgs: The security configuration to set. see Data Catalog Encryption Settings.

catalogId String: The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.
dataCatalogEncryptionSettings Property Map: The security configuration to set. see Data Catalog Encryption Settings.

Supporting Types

DataCatalogEncryptionSettingsDataCatalogEncryptionSettings

ConnectionPasswordEncryption DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption: When connection password protection is enabled, the Data Catalog uses a customer-provided key 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. see Connection Password Encryption.
EncryptionAtRest DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest: Specifies the encryption-at-rest configuration for the Data Catalog. see Encryption At Rest.

ConnectionPasswordEncryption DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption: When connection password protection is enabled, the Data Catalog uses a customer-provided key 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. see Connection Password Encryption.
EncryptionAtRest DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest: Specifies the encryption-at-rest configuration for the Data Catalog. see Encryption At Rest.

connectionPasswordEncryption DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption: When connection password protection is enabled, the Data Catalog uses a customer-provided key 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. see Connection Password Encryption.
encryptionAtRest DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest: Specifies the encryption-at-rest configuration for the Data Catalog. see Encryption At Rest.

connectionPasswordEncryption DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption: When connection password protection is enabled, the Data Catalog uses a customer-provided key 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. see Connection Password Encryption.
encryptionAtRest DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest: Specifies the encryption-at-rest configuration for the Data Catalog. see Encryption At Rest.

connection_password_encryption DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption: When connection password protection is enabled, the Data Catalog uses a customer-provided key 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. see Connection Password Encryption.
encryption_at_rest DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest: Specifies the encryption-at-rest configuration for the Data Catalog. see Encryption At Rest.

connectionPasswordEncryption Property Map: When connection password protection is enabled, the Data Catalog uses a customer-provided key 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. see Connection Password Encryption.
encryptionAtRest Property Map: Specifies the encryption-at-rest configuration for the Data Catalog. see Encryption At Rest.

DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption

ReturnConnectionPasswordEncrypted bool: When set to true, passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently of the catalog encryption.
AwsKmsKeyId string: A KMS key ARN that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

ReturnConnectionPasswordEncrypted bool: When set to true, passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently of the catalog encryption.
AwsKmsKeyId string: A KMS key ARN that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

returnConnectionPasswordEncrypted Boolean: When set to true, passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently of the catalog encryption.
awsKmsKeyId String: A KMS key ARN that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

returnConnectionPasswordEncrypted boolean: When set to true, passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently of the catalog encryption.
awsKmsKeyId string: A KMS key ARN that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

return_connection_password_encrypted bool: When set to true, passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently of the catalog encryption.
aws_kms_key_id str: A KMS key ARN that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

returnConnectionPasswordEncrypted Boolean: When set to true, passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently of the catalog encryption.
awsKmsKeyId String: A KMS key ARN that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest

CatalogEncryptionMode string: The encryption-at-rest mode for encrypting Data Catalog data. Valid values are DISABLED and SSE-KMS.
SseAwsKmsKeyId string: The ARN of the AWS KMS key to use for encryption at rest.

CatalogEncryptionMode string: The encryption-at-rest mode for encrypting Data Catalog data. Valid values are DISABLED and SSE-KMS.
SseAwsKmsKeyId string: The ARN of the AWS KMS key to use for encryption at rest.

catalogEncryptionMode String: The encryption-at-rest mode for encrypting Data Catalog data. Valid values are DISABLED and SSE-KMS.
sseAwsKmsKeyId String: The ARN of the AWS KMS key to use for encryption at rest.

catalogEncryptionMode string: The encryption-at-rest mode for encrypting Data Catalog data. Valid values are DISABLED and SSE-KMS.
sseAwsKmsKeyId string: The ARN of the AWS KMS key to use for encryption at rest.

catalog_encryption_mode str: The encryption-at-rest mode for encrypting Data Catalog data. Valid values are DISABLED and SSE-KMS.
sse_aws_kms_key_id str: The ARN of the AWS KMS key to use for encryption at rest.

catalogEncryptionMode String: The encryption-at-rest mode for encrypting Data Catalog data. Valid values are DISABLED and SSE-KMS.
sseAwsKmsKeyId String: The ARN of the AWS KMS key to use for encryption at rest.

Import

Glue Data Catalog Encryption Settings can be imported using CATALOG-ID (AWS account ID if not custom), e.g.,

 $ pulumi import aws:glue/dataCatalogEncryptionSettings:DataCatalogEncryptionSettings example 123456789012

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.