Package software.amazon.awscdk.services.glue

Class CfnDatabase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.glue.CfnDatabase

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:02.625Z")
@Stability(Stable)
public class CfnDatabase
extends CfnResource
implements IInspectable

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")
                 .federatedDatabase(FederatedDatabaseProperty.builder()
                         .connectionName("connectionName")
                         .identifier("identifier")
                         .build())
                 .locationUri("locationUri")
                 .name("name")
                 .parameters(parameters)
                 .targetDatabase(DatabaseIdentifierProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .region("region")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.FederatedDatabaseProperty	A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog .
static interface	CfnDatabase.PrincipalPrivilegesProperty	the permissions granted to a principal.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDatabase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDatabase(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDatabase(software.constructs.Construct scope, String id, CfnDatabaseProps props)

Method Summary

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

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDatabase

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

CfnDatabase

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

CfnDatabase

@Stability(Stable)
public CfnDatabase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDatabaseProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 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

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCatalogId

@Stability(Stable)
@NotNull
public String getCatalogId()

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

setCatalogId

@Stability(Stable)
public void setCatalogId(@NotNull
 String value)

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

getDatabaseInput

@Stability(Stable)
@NotNull
public Object getDatabaseInput()

The metadata for the database.

setDatabaseInput

@Stability(Stable)
public void setDatabaseInput(@NotNull
 IResolvable value)

The metadata for the database.

setDatabaseInput

@Stability(Stable)
public void setDatabaseInput(@NotNull
 CfnDatabase.DatabaseInputProperty value)

The metadata for the database.