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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.535Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDatabase(software.constructs.Construct scope, 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
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(CfnDatabase.DatabaseInputProperty value) The metadata for the database.
void	setDatabaseInput(IResolvable value) The metadata for the database.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnDatabase(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCatalogId

@Stability(value=Stable)
 @NotNull
public 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

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

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

The metadata for the database.

setDatabaseInput

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

The metadata for the database.

setDatabaseInput

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

The metadata for the database.