Interface Catalog.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Catalog.Builder,Catalog>, SdkBuilder<Catalog.Builder,Catalog>, SdkPojo
Enclosing class:
Catalog
@Mutable @NotThreadSafe public static interface Catalog.Builder extends SdkPojo, CopyableBuilder<Catalog.Builder,Catalog>

  • Method Details

    • catalogId

      Catalog.Builder catalogId(String catalogId)

      The ID of the catalog. To grant access to the default catalog, this field should not be provided.

      Parameters:
      catalogId - The ID of the catalog. To grant access to the default catalog, this field should not be provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Catalog.Builder name(String name)

      The name of the catalog. Cannot be the same as the account ID.

      Parameters:
      name - The name of the catalog. Cannot be the same as the account ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArn

      Catalog.Builder resourceArn(String resourceArn)

      The Amazon Resource Name (ARN) assigned to the catalog resource.

      Parameters:
      resourceArn - The Amazon Resource Name (ARN) assigned to the catalog resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Catalog.Builder description(String description)

      Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.

      Parameters:
      description - Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      Catalog.Builder parameters(Map<String,String> parameters)

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

      Parameters:
      parameters - A map array of key-value pairs that define parameters and properties of the catalog.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createTime

      Catalog.Builder createTime(Instant createTime)

      The time at which the catalog was created.

      Parameters:
      createTime - The time at which the catalog was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updateTime

      Catalog.Builder updateTime(Instant updateTime)

      The time at which the catalog was last updated.

      Parameters:
      updateTime - The time at which the catalog was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetRedshiftCatalog

      Catalog.Builder targetRedshiftCatalog(TargetRedshiftCatalog targetRedshiftCatalog)

      A TargetRedshiftCatalog object that describes a target catalog for database resource linking.

      Parameters:
      targetRedshiftCatalog - A TargetRedshiftCatalog object that describes a target catalog for database resource linking.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetRedshiftCatalog

      default Catalog.Builder targetRedshiftCatalog(Consumer<TargetRedshiftCatalog.Builder> targetRedshiftCatalog)

      A TargetRedshiftCatalog object that describes a target catalog for database resource linking.

      This is a convenience method that creates an instance of the TargetRedshiftCatalog.Builder avoiding the need to create one manually via TargetRedshiftCatalog.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetRedshiftCatalog(TargetRedshiftCatalog).

      Parameters:
      targetRedshiftCatalog - a consumer that will call methods on TargetRedshiftCatalog.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • federatedCatalog

      Catalog.Builder federatedCatalog(FederatedCatalog federatedCatalog)

      A FederatedCatalog object that points to an entity outside the Glue Data Catalog.

      Parameters:
      federatedCatalog - A FederatedCatalog object that points to an entity outside the Glue Data Catalog.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • federatedCatalog

      default Catalog.Builder federatedCatalog(Consumer<FederatedCatalog.Builder> federatedCatalog)

      A FederatedCatalog object that points to an entity outside the Glue Data Catalog.

      This is a convenience method that creates an instance of the FederatedCatalog.Builder avoiding the need to create one manually via FederatedCatalog.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to federatedCatalog(FederatedCatalog).

      Parameters:
      federatedCatalog - a consumer that will call methods on FederatedCatalog.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • catalogProperties

      Catalog.Builder catalogProperties(CatalogPropertiesOutput catalogProperties)

      A CatalogProperties object that specifies data lake access properties and other custom properties.

      Parameters:
      catalogProperties - A CatalogProperties object that specifies data lake access properties and other custom properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • catalogProperties

      default Catalog.Builder catalogProperties(Consumer<CatalogPropertiesOutput.Builder> catalogProperties)

      A CatalogProperties object that specifies data lake access properties and other custom properties.

      This is a convenience method that creates an instance of the CatalogPropertiesOutput.Builder avoiding the need to create one manually via CatalogPropertiesOutput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to catalogProperties(CatalogPropertiesOutput).

      Parameters:
      catalogProperties - a consumer that will call methods on CatalogPropertiesOutput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createTableDefaultPermissions

      Catalog.Builder createTableDefaultPermissions(Collection<PrincipalPermissions> createTableDefaultPermissions)

      An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

      Parameters:
      createTableDefaultPermissions - An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createTableDefaultPermissions

      Catalog.Builder createTableDefaultPermissions(PrincipalPermissions... createTableDefaultPermissions)

      An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

      Parameters:
      createTableDefaultPermissions - An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createTableDefaultPermissions

      Catalog.Builder createTableDefaultPermissions(Consumer<PrincipalPermissions.Builder>... createTableDefaultPermissions)

      An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

      This is a convenience method that creates an instance of the PrincipalPermissions.Builder avoiding the need to create one manually via PrincipalPermissions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createTableDefaultPermissions(List<PrincipalPermissions>).

      Parameters:
      createTableDefaultPermissions - a consumer that will call methods on PrincipalPermissions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createDatabaseDefaultPermissions

      Catalog.Builder createDatabaseDefaultPermissions(Collection<PrincipalPermissions> createDatabaseDefaultPermissions)

      An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

      Parameters:
      createDatabaseDefaultPermissions - An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createDatabaseDefaultPermissions

      Catalog.Builder createDatabaseDefaultPermissions(PrincipalPermissions... createDatabaseDefaultPermissions)

      An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

      Parameters:
      createDatabaseDefaultPermissions - An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createDatabaseDefaultPermissions

      Catalog.Builder createDatabaseDefaultPermissions(Consumer<PrincipalPermissions.Builder>... createDatabaseDefaultPermissions)

      An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

      This is a convenience method that creates an instance of the PrincipalPermissions.Builder avoiding the need to create one manually via PrincipalPermissions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createDatabaseDefaultPermissions(List<PrincipalPermissions>).

      Parameters:
      createDatabaseDefaultPermissions - a consumer that will call methods on PrincipalPermissions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • allowFullTableExternalDataAccess

      Catalog.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • allowFullTableExternalDataAccess

      Catalog.Builder allowFullTableExternalDataAccess(AllowFullTableExternalDataAccessEnum 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: