Package software.amazon.awscdk.services.glue

Class CfnCatalog.Builder

java.lang.Object

software.amazon.awscdk.services.glue.CfnCatalog.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCatalog>

Enclosing class:

CfnCatalog

@Stability(Stable)
public static final class CfnCatalog.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCatalog>

A fluent builder for CfnCatalog.

Method Summary

Modifier and Type	Method	Description
CfnCatalog.Builder	allowFullTableExternalDataAccess(String allowFullTableExternalDataAccess)	Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
CfnCatalog	build()
CfnCatalog.Builder	catalogProperties(IResolvable catalogProperties)	A structure that specifies data lake access properties and other custom properties.
CfnCatalog.Builder	catalogProperties(CfnCatalog.CatalogPropertiesProperty catalogProperties)	A structure that specifies data lake access properties and other custom properties.
static CfnCatalog.Builder	create(software.constructs.Construct scope, String id)
CfnCatalog.Builder	createDatabaseDefaultPermissions(List<? extends Object> createDatabaseDefaultPermissions)	An array of PrincipalPermissions objects for default database permissions.
CfnCatalog.Builder	createDatabaseDefaultPermissions(IResolvable createDatabaseDefaultPermissions)	An array of PrincipalPermissions objects for default database permissions.
CfnCatalog.Builder	createTableDefaultPermissions(List<? extends Object> createTableDefaultPermissions)	An array of PrincipalPermissions objects for default table permissions.
CfnCatalog.Builder	createTableDefaultPermissions(IResolvable createTableDefaultPermissions)	An array of PrincipalPermissions objects for default table permissions.
CfnCatalog.Builder	description(String description)	A description of the catalog.
CfnCatalog.Builder	federatedCatalog(IResolvable federatedCatalog)	A FederatedCatalog structure that references an entity outside the Glue Data Catalog.
CfnCatalog.Builder	federatedCatalog(CfnCatalog.FederatedCatalogProperty federatedCatalog)	A FederatedCatalog structure that references an entity outside the Glue Data Catalog.
CfnCatalog.Builder	name(String name)	The name of the catalog to create.
CfnCatalog.Builder	overwriteChildResourcePermissionsWithDefault(String overwriteChildResourcePermissionsWithDefault)	Specifies whether to overwrite child resource permissions with the default permissions.
CfnCatalog.Builder	parameters(Map<String,String> parameters)	A map of key-value pairs that define parameters and properties of the catalog.
CfnCatalog.Builder	parameters(IResolvable parameters)	A map of key-value pairs that define parameters and properties of the catalog.
CfnCatalog.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnCatalog.Builder	targetRedshiftCatalog(IResolvable targetRedshiftCatalog)	A structure that describes a target catalog for resource linking.
CfnCatalog.Builder	targetRedshiftCatalog(CfnCatalog.TargetRedshiftCatalogProperty targetRedshiftCatalog)	A structure that describes a target catalog for resource linking.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCatalog.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnCatalog.Builder.

name

@Stability(Stable)
public CfnCatalog.Builder name(String name)

The name of the catalog to create.

Parameters:

name - The name of the catalog to create. This parameter is required.

Returns:

this

See Also:

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

allowFullTableExternalDataAccess

@Stability(Stable)
public CfnCatalog.Builder allowFullTableExternalDataAccess(String allowFullTableExternalDataAccess)

Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

Parameters:

allowFullTableExternalDataAccess - Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation. This parameter is required.

Returns:

this

See Also:

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

catalogProperties

@Stability(Stable)
public CfnCatalog.Builder catalogProperties(IResolvable catalogProperties)

A structure that specifies data lake access properties and other custom properties.

Parameters:

catalogProperties - A structure that specifies data lake access properties and other custom properties. This parameter is required.

Returns:

this

See Also:

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

catalogProperties

@Stability(Stable)
public CfnCatalog.Builder catalogProperties(CfnCatalog.CatalogPropertiesProperty catalogProperties)

A structure that specifies data lake access properties and other custom properties.

Parameters:

catalogProperties - A structure that specifies data lake access properties and other custom properties. This parameter is required.

Returns:

this

See Also:

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

createDatabaseDefaultPermissions

@Stability(Stable)
public CfnCatalog.Builder createDatabaseDefaultPermissions(IResolvable createDatabaseDefaultPermissions)

An array of PrincipalPermissions objects for default database permissions.

Parameters:

createDatabaseDefaultPermissions - An array of PrincipalPermissions objects for default database permissions. This parameter is required.

Returns:

this

See Also:

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

createDatabaseDefaultPermissions

@Stability(Stable)
public CfnCatalog.Builder createDatabaseDefaultPermissions(List<? extends Object> createDatabaseDefaultPermissions)

An array of PrincipalPermissions objects for default database permissions.

Parameters:

createDatabaseDefaultPermissions - An array of PrincipalPermissions objects for default database permissions. This parameter is required.

Returns:

this

See Also:

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

createTableDefaultPermissions

@Stability(Stable)
public CfnCatalog.Builder createTableDefaultPermissions(IResolvable createTableDefaultPermissions)

An array of PrincipalPermissions objects for default table permissions.

Parameters:

createTableDefaultPermissions - An array of PrincipalPermissions objects for default table permissions. This parameter is required.

Returns:

this

See Also:

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

createTableDefaultPermissions

@Stability(Stable)
public CfnCatalog.Builder createTableDefaultPermissions(List<? extends Object> createTableDefaultPermissions)

An array of PrincipalPermissions objects for default table permissions.

Parameters:

createTableDefaultPermissions - An array of PrincipalPermissions objects for default table permissions. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnCatalog.Builder description(String description)

A description of the catalog.

Parameters:

description - A description of the catalog. This parameter is required.

Returns:

this

See Also:

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

federatedCatalog

@Stability(Stable)
public CfnCatalog.Builder federatedCatalog(IResolvable federatedCatalog)

A FederatedCatalog structure that references an entity outside the Glue Data Catalog.

Parameters:

federatedCatalog - A FederatedCatalog structure that references an entity outside the Glue Data Catalog. This parameter is required.

Returns:

this

See Also:

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

federatedCatalog

@Stability(Stable)
public CfnCatalog.Builder federatedCatalog(CfnCatalog.FederatedCatalogProperty federatedCatalog)

A FederatedCatalog structure that references an entity outside the Glue Data Catalog.

Parameters:

federatedCatalog - A FederatedCatalog structure that references an entity outside the Glue Data Catalog. This parameter is required.

Returns:

this

See Also:

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

overwriteChildResourcePermissionsWithDefault

@Stability(Stable)
public CfnCatalog.Builder overwriteChildResourcePermissionsWithDefault(String overwriteChildResourcePermissionsWithDefault)

Specifies whether to overwrite child resource permissions with the default permissions.

Parameters:

overwriteChildResourcePermissionsWithDefault - Specifies whether to overwrite child resource permissions with the default permissions. This parameter is required.

Returns:

this

See Also:

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

parameters

@Stability(Stable)
public CfnCatalog.Builder parameters(Map<String,String> parameters)

A map of key-value pairs that define parameters and properties of the catalog.

Parameters:

parameters - A map of key-value pairs that define parameters and properties of the catalog. This parameter is required.

Returns:

this

See Also:

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

parameters

@Stability(Stable)
public CfnCatalog.Builder parameters(IResolvable parameters)

A map of key-value pairs that define parameters and properties of the catalog.

Parameters:

parameters - A map of key-value pairs that define parameters and properties of the catalog. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnCatalog.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

targetRedshiftCatalog

@Stability(Stable)
public CfnCatalog.Builder targetRedshiftCatalog(IResolvable targetRedshiftCatalog)

A structure that describes a target catalog for resource linking.

Parameters:

targetRedshiftCatalog - A structure that describes a target catalog for resource linking. This parameter is required.

Returns:

this

See Also:

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

targetRedshiftCatalog

@Stability(Stable)
public CfnCatalog.Builder targetRedshiftCatalog(CfnCatalog.TargetRedshiftCatalogProperty targetRedshiftCatalog)

A structure that describes a target catalog for resource linking.

Parameters:

targetRedshiftCatalog - A structure that describes a target catalog for resource linking. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnCatalog build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCatalog>

Returns:

a newly built instance of CfnCatalog.