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:
IEnvironmentAware, IInspectable, IDatabaseRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:06.851Z") @Stability(Stable) public class CfnDatabase extends CfnResource implements IInspectable, IDatabaseRef
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())
         // the properties below are optional
         .databaseName("databaseName")
         .build();

See Also:

  • 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

    • fromDatabaseName

      @Stability(Stable) @NotNull public static IDatabaseRef fromDatabaseName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String databaseName)
      Creates a new IDatabaseRef from a databaseName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      databaseName - This parameter is required.

    • 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.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDatabaseRef

      @Stability(Stable) @NotNull public DatabaseReference getDatabaseRef()
      A reference to a Database resource.
      Specified by:
      getDatabaseRef in interface IDatabaseRef

    • 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.

      Returns union: either IResolvable or CfnDatabase.DatabaseInputProperty

    • 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.

    • getDatabaseName

      @Stability(Stable) @Nullable public String getDatabaseName()
      The name of the catalog database.

    • setDatabaseName

      @Stability(Stable) public void setDatabaseName(@Nullable String value)
      The name of the catalog database.