Skip to content
v2.278.0

DatabaseInputProperty Struct ​

The structure used to create or update a database.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';

declare const parameters: any;
const databaseInputProperty: glue.CfnDatabase.DatabaseInputProperty = {
  createTableDefaultPermissions: [{
    permissions: ['permissions'],
    principal: {
      dataLakePrincipalIdentifier: 'dataLakePrincipalIdentifier',
    },
  }],
  description: 'description',
  federatedDatabase: {
    connectionName: 'connectionName',
    identifier: 'identifier',
  },
  locationUri: 'locationUri',
  name: 'name',
  parameters: parameters,
  targetDatabase: {
    catalogId: 'catalogId',
    databaseName: 'databaseName',
    region: 'region',
  },
};
python
# 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

database_input_property = 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"
    )
)
java
// 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;

DatabaseInputProperty databaseInputProperty = 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Glue;

var parameters;

var databaseInputProperty = new DatabaseInputProperty {
    CreateTableDefaultPermissions = new [] { new PrincipalPrivilegesProperty {
        Permissions = new [] { "permissions" },
        Principal = new DataLakePrincipalProperty {
            DataLakePrincipalIdentifier = "dataLakePrincipalIdentifier"
        }
    } },
    Description = "description",
    FederatedDatabase = new FederatedDatabaseProperty {
        ConnectionName = "connectionName",
        Identifier = "identifier"
    },
    LocationUri = "locationUri",
    Name = "name",
    Parameters = parameters,
    TargetDatabase = new DatabaseIdentifierProperty {
        CatalogId = "catalogId",
        DatabaseName = "databaseName",
        Region = "region"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var parameters interface{}

databaseInputProperty := &DatabaseInputProperty{
	CreateTableDefaultPermissions: []interface{}{
		&PrincipalPrivilegesProperty{
			Permissions: []*string{
				jsii.String("permissions"),
			},
			Principal: &DataLakePrincipalProperty{
				DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"),
			},
		},
	},
	Description: jsii.String("description"),
	FederatedDatabase: &FederatedDatabaseProperty{
		ConnectionName: jsii.String("connectionName"),
		Identifier: jsii.String("identifier"),
	},
	LocationUri: jsii.String("locationUri"),
	Name: jsii.String("name"),
	Parameters: parameters,
	TargetDatabase: &DatabaseIdentifierProperty{
		CatalogId: jsii.String("catalogId"),
		DatabaseName: jsii.String("databaseName"),
		Region: jsii.String("region"),
	},
}

Properties ​

createTableDefaultPermissionsoptionalIResolvable | IResolvable | CfnDatabase.PrincipalPrivilegesProperty[]create_table_default_permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrincipalPrivilegesProperty]]]createTableDefaultPermissionsoptionalIResolvableCreateTableDefaultPermissionsoptionalIResolvableCreateTableDefaultPermissionsoptionalinterface{} #
Creates a set of default permissions on the table for principals.

Used by AWS Lake Formation . Not used in the normal course of AWS Glue operations.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
A description of the database.
federatedDatabaseoptionalIResolvable | CfnDatabase.FederatedDatabasePropertyfederated_databaseoptionaltyping.Union[IResolvable, FederatedDatabaseProperty]federatedDatabaseoptionalIResolvableFederatedDatabaseoptionalIResolvableFederatedDatabaseoptionalinterface{} #
A `FederatedDatabase` structure that references an entity outside the AWS Glue Data Catalog .
locationUrioptionalstringlocation_urioptionalstrlocationUrioptionalStringLocationUrioptionalstringLocationUrioptional*string #
The location of the database (for example, an HDFS path).
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string #
The name of the database.

For Hive compatibility, this is folded to lowercase when it is stored.

parametersoptionalanyparametersoptionalAnyparametersoptionalObjectParametersoptionalobjectParametersoptionalinterface{} #
These key-value pairs define parameters and properties of the database.
targetDatabaseoptionalIResolvable | CfnDatabase.DatabaseIdentifierPropertytarget_databaseoptionaltyping.Union[IResolvable, DatabaseIdentifierProperty]targetDatabaseoptionalIResolvableTargetDatabaseoptionalIResolvableTargetDatabaseoptionalinterface{} #
A `DatabaseIdentifier` structure that describes a target database for resource linking.