Interface GrantPermissionsRequest.Builder

  • Method Details

    • catalogId

      The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

      Parameters:
      catalogId - The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • principal

      The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.

      Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.

      Parameters:
      principal - The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.

      Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • principal

      The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.

      Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.

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

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

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

      The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.

      Parameters:
      resource - The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resource

      The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.

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

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

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

      GrantPermissionsRequest.Builder permissionsWithStrings(Collection<String> permissions)

      The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.

      Parameters:
      permissions - The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • permissionsWithStrings

      GrantPermissionsRequest.Builder permissionsWithStrings(String... permissions)

      The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.

      Parameters:
      permissions - The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • permissions

      The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.

      Parameters:
      permissions - The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • permissions

      GrantPermissionsRequest.Builder permissions(Permission... permissions)

      The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.

      Parameters:
      permissions - The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • condition

      Sets the value of the Condition property for this object.
      Parameters:
      condition - The new value for the Condition property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • condition

      Sets the value of the Condition property for this object. This is a convenience method that creates an instance of the Condition.Builder avoiding the need to create one manually via Condition.builder().

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

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

      GrantPermissionsRequest.Builder permissionsWithGrantOptionWithStrings(Collection<String> permissionsWithGrantOption)

      Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

      Parameters:
      permissionsWithGrantOption - Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • permissionsWithGrantOptionWithStrings

      GrantPermissionsRequest.Builder permissionsWithGrantOptionWithStrings(String... permissionsWithGrantOption)

      Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

      Parameters:
      permissionsWithGrantOption - Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • permissionsWithGrantOption

      GrantPermissionsRequest.Builder permissionsWithGrantOption(Collection<Permission> permissionsWithGrantOption)

      Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

      Parameters:
      permissionsWithGrantOption - Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • permissionsWithGrantOption

      GrantPermissionsRequest.Builder permissionsWithGrantOption(Permission... permissionsWithGrantOption)

      Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

      Parameters:
      permissionsWithGrantOption - Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      GrantPermissionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.