CfnDatabaseProps

class aws_cdk.aws_glue.CfnDatabaseProps(*, catalog_id, database_input, database_name=None)

Bases: object

Properties for defining a CfnDatabase.

Parameters:
  • catalog_id (str) – The AWS account ID for the account in which to create the catalog object. .. epigraph:: To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId

  • database_input (Union[IResolvable, DatabaseInputProperty, Dict[str, Any]]) – The metadata for the database.

  • database_name (Optional[str]) – The name of the catalog database.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_glue as glue

# parameters: Any

cfn_database_props = glue.CfnDatabaseProps(
    catalog_id="catalogId",
    database_input=glue.CfnDatabase.DatabaseInputProperty(
        create_table_default_permissions=[glue.CfnDatabase.PrincipalPrivilegesProperty(
            permissions=["permissions"],
            principal=glue.CfnDatabase.DataLakePrincipalProperty(
                data_lake_principal_identifier="dataLakePrincipalIdentifier"
            )
        )],
        description="description",
        federated_database=glue.CfnDatabase.FederatedDatabaseProperty(
            connection_name="connectionName",
            identifier="identifier"
        ),
        location_uri="locationUri",
        name="name",
        parameters=parameters,
        target_database=glue.CfnDatabase.DatabaseIdentifierProperty(
            catalog_id="catalogId",
            database_name="databaseName",
            region="region"
        )
    ),

    # the properties below are optional
    database_name="databaseName"
)

Attributes

catalog_id

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:

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

database_input

The metadata for the database.

See:

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

database_name

The name of the catalog database.

See:

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