Package software.amazon.awscdk.services.glue

Interface CfnDatabaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatabaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:37.482Z")
@Stability(Stable)
public interface CfnDatabaseProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDatabase.

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;
 CfnDatabaseProps cfnDatabaseProps = CfnDatabaseProps.builder()
         .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())
         // the properties below are optional
         .databaseName("databaseName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDatabaseProps.Builder	A builder for CfnDatabaseProps
static final class	CfnDatabaseProps.Jsii$Proxy	An implementation for CfnDatabaseProps

Method Summary

Modifier and Type	Method	Description
static CfnDatabaseProps.Builder	builder()
String	getCatalogId()	The AWS account ID for the account in which to create the catalog object.
Object	getDatabaseInput()	The metadata for the database.
default String	getDatabaseName()	The name of the catalog database.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCatalogId

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

See Also:

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

getDatabaseInput

@Stability(Stable)
@NotNull
Object getDatabaseInput()

The metadata for the database.

Returns union: either IResolvable or CfnDatabase.DatabaseInputProperty

See Also:

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

getDatabaseName

@Stability(Stable)
@Nullable
default String getDatabaseName()

The name of the catalog database.

See Also:

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

builder

@Stability(Stable)
static CfnDatabaseProps.Builder builder()

Returns:

a CfnDatabaseProps.Builder of CfnDatabaseProps