Package software.amazon.awscdk.services.glue

Class CfnDatabase

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.383Z") @Stability(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")
                 .federatedDatabase(FederatedDatabaseProperty.builder()
                         .connectionName("connectionName")
                         .identifier("identifier")
                         .build())
                 .locationUri("locationUri")
                 .name("name")
                 .parameters(parameters)
                 .targetDatabase(DatabaseIdentifierProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .build())
                 .build())
         .build();

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

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

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