DataCatalogEncryptionSettings class

Provides a Glue Data Catalog Encryption Settings resource.

Example Usage

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

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

example = aws.glue.DataCatalogEncryptionSettings("example", data_catalog_encryption_settings={
    "connection_password_encryption": {
        "aws_kms_key_id": test["arn"],
        "return_connection_password_encrypted": True,
    },
    "encryption_at_rest": {
        "catalog_encryption_mode": "SSE-KMS",
        "catalog_encryption_service_role": test_aws_iam_role["arn"],
        "sse_aws_kms_key_id": test["arn"],
    },
})
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 = test.Arn,
                ReturnConnectionPasswordEncrypted = true,
            },
            EncryptionAtRest = new Aws.Glue.Inputs.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRestArgs
            {
                CatalogEncryptionMode = "SSE-KMS",
                CatalogEncryptionServiceRole = testAwsIamRole.Arn,
                SseAwsKmsKeyId = test.Arn,
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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(test.Arn),
					ReturnConnectionPasswordEncrypted: pulumi.Bool(true),
				},
				EncryptionAtRest: &glue.DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRestArgs{
					CatalogEncryptionMode:        pulumi.String("SSE-KMS"),
					CatalogEncryptionServiceRole: pulumi.Any(testAwsIamRole.Arn),
					SseAwsKmsKeyId:               pulumi.Any(test.Arn),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_datacatalogencryptionsettings" "example" {
  data_catalog_encryption_settings = {
    connection_password_encryption = {
      aws_kms_key_id                       = test.arn
      return_connection_password_encrypted = true
    }
    encryption_at_rest = {
      catalog_encryption_mode         = "SSE-KMS"
      catalog_encryption_service_role = testAwsIamRole.arn
      sse_aws_kms_key_id              = test.arn
    }
  }
}
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.ArrayList;
import java.util.Arrays;
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(test.arn())
                    .returnConnectionPasswordEncrypted(true)
                    .build())
                .encryptionAtRest(DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRestArgs.builder()
                    .catalogEncryptionMode("SSE-KMS")
                    .catalogEncryptionServiceRole(testAwsIamRole.arn())
                    .sseAwsKmsKeyId(test.arn())
                    .build())
                .build())
            .build());

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

Import

Using pulumi import, import Glue Data Catalog Encryption Settings using CATALOG-ID (AWS account ID if not custom). For example:

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

Constructors

DataCatalogEncryptionSettings(String name, {DataCatalogEncryptionSettingsArgs? args, CustomResourceOptions? options})
Creates a new DataCatalogEncryptionSettings. name The Pulumi resource name. args Arguments used to configure this DataCatalogEncryptionSettings. The set of arguments for DataCatalogEncryptionSettings. options Resource options controlling this resource's behavior.
DataCatalogEncryptionSettings.reference(String urn)
Creates a typed reference to an existing DataCatalogEncryptionSettings resource.

Properties

catalogId ↔ Output<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.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dataCatalogEncryptionSettings ↔ Output<DataCatalogEncryptionSettingsDataCatalogEncryptionSettings>
The security configuration to set. see Data Catalog Encryption Settings.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DataCatalogEncryptionSettingsState? state, CustomResourceOptions? options}) → DataCatalogEncryptionSettings
Gets an existing DataCatalogEncryptionSettings resource's state with the given name and id.