software.amazon.awscdk.services.glue

Class CfnDatabase

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.glue.CfnDatabase

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.513Z")
public class CfnDatabase
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Glue::Database`.

The AWS::Glue::Database resource specifies a logical grouping of tables in AWS Glue . For more information, see Defining a Database in Your Data Catalog and Database Structure in the AWS Glue Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object parameters;
 CfnDatabase cfnDatabase = CfnDatabase.Builder.create(this, "MyCfnDatabase")
         .catalogId("catalogId")
         .databaseInput(DatabaseInputProperty.builder()
                 .createTableDefaultPermissions(List.of(PrincipalPrivilegesProperty.builder()
                         .permissions(List.of("permissions"))
                         .principal(DataLakePrincipalProperty.builder()
                                 .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                                 .build())
                         .build()))
                 .description("description")
                 .locationUri("locationUri")
                 .name("name")
                 .parameters(parameters)
                 .targetDatabase(DatabaseIdentifierProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDatabase.Builder A fluent builder for CfnDatabase.
static interface	CfnDatabase.DatabaseIdentifierProperty A structure that describes a target database for resource linking.
static interface	CfnDatabase.DatabaseInputProperty The structure used to create or update a database.
static interface	CfnDatabase.DataLakePrincipalProperty The AWS Lake Formation principal.
static interface	CfnDatabase.PrincipalPrivilegesProperty the permissions granted to a principal.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDatabase(Construct scope, java.lang.String id, CfnDatabaseProps props) Create a new `AWS::Glue::Database`.
protected	CfnDatabase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDatabase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatalogId() The AWS account ID for the account in which to create the catalog object.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getDatabaseInput() The metadata for the database.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCatalogId(java.lang.String value) The AWS account ID for the account in which to create the catalog object.
void	setDatabaseInput(CfnDatabase.DatabaseInputProperty value) The metadata for the database.
void	setDatabaseInput(IResolvable value) The metadata for the database.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDatabase

protected CfnDatabase(software.amazon.jsii.JsiiObjectRef objRef)

CfnDatabase

protected CfnDatabase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDatabase

public CfnDatabase(Construct scope,
                   java.lang.String id,
                   CfnDatabaseProps props)

Create a new `AWS::Glue::Database`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCatalogId

public java.lang.String getCatalogId()

The AWS account ID for the account in which to create the catalog object.

To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId

setCatalogId

public void setCatalogId(java.lang.String value)

The AWS account ID for the account in which to create the catalog object.

To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId

getDatabaseInput

public java.lang.Object getDatabaseInput()

The metadata for the database.

setDatabaseInput

public void setDatabaseInput(IResolvable value)

The metadata for the database.

setDatabaseInput

public void setDatabaseInput(CfnDatabase.DatabaseInputProperty value)

The metadata for the database.