Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. lakeformation
  5. OptIn
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.lakeformation.OptIn

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS Lake Formation Opt In.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lakeformation.OptIn("example", {});

    import pulumi
import pulumi_aws as aws

example = aws.lakeformation.OptIn("example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lakeformation"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lakeformation.NewOptIn(ctx, "example", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.LakeFormation.OptIn("example");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lakeformation.OptIn;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new OptIn("example");

    }
}

    resources:
  example:
    type: aws:lakeformation:OptIn

    Create OptIn Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OptIn(name: string, args?: OptInArgs, opts?: CustomResourceOptions);
    @overload
def OptIn(resource_name: str,
          args: Optional[OptInArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def OptIn(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          conditions: Optional[Sequence[OptInConditionArgs]] = None,
          principals: Optional[Sequence[OptInPrincipalArgs]] = None,
          resource_datas: Optional[Sequence[OptInResourceDataArgs]] = None)
    func NewOptIn(ctx *Context, name string, args *OptInArgs, opts ...ResourceOption) (*OptIn, error)
    public OptIn(string name, OptInArgs? args = null, CustomResourceOptions? opts = null)
    public OptIn(String name, OptInArgs args)
public OptIn(String name, OptInArgs args, CustomResourceOptions options)

    type: aws:lakeformation:OptIn
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OptInArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OptInArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OptInArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OptInArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OptInArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var optInResource = new Aws.LakeFormation.OptIn("optInResource", new()
{
    Conditions = new[]
    {
        new Aws.LakeFormation.Inputs.OptInConditionArgs
        {
            Expression = "string",
        },
    },
    Principals = new[]
    {
        new Aws.LakeFormation.Inputs.OptInPrincipalArgs
        {
            DataLakePrincipalIdentifier = "string",
        },
    },
    ResourceDatas = new[]
    {
        new Aws.LakeFormation.Inputs.OptInResourceDataArgs
        {
            Catalogs = new[]
            {
                new Aws.LakeFormation.Inputs.OptInResourceDataCatalogArgs
                {
                    Id = "string",
                },
            },
            DataCellsFilters = new[]
            {
                new Aws.LakeFormation.Inputs.OptInResourceDataDataCellsFilterArgs
                {
                    DatabaseName = "string",
                    Name = "string",
                    TableCatalogId = "string",
                    TableName = "string",
                },
            },
            DataLocations = new[]
            {
                new Aws.LakeFormation.Inputs.OptInResourceDataDataLocationArgs
                {
                    ResourceArn = "string",
                    CatalogId = "string",
                },
            },
            Database = new Aws.LakeFormation.Inputs.OptInResourceDataDatabaseArgs
            {
                Name = "string",
                CatalogId = "string",
            },
            LfTag = new Aws.LakeFormation.Inputs.OptInResourceDataLfTagArgs
            {
                Key = "string",
                Value = "string",
                CatalogId = "string",
            },
            LfTagExpressions = new[]
            {
                new Aws.LakeFormation.Inputs.OptInResourceDataLfTagExpressionArgs
                {
                    Name = "string",
                    CatalogId = "string",
                },
            },
            LfTagPolicies = new[]
            {
                new Aws.LakeFormation.Inputs.OptInResourceDataLfTagPolicyArgs
                {
                    ResourceType = "string",
                    CatalogId = "string",
                    ExpressionName = "string",
                    Expressions = new[]
                    {
                        "string",
                    },
                },
            },
            Table = new Aws.LakeFormation.Inputs.OptInResourceDataTableArgs
            {
                DatabaseName = "string",
                CatalogId = "string",
                Name = "string",
                Wildcard = false,
            },
            TableWithColumns = new Aws.LakeFormation.Inputs.OptInResourceDataTableWithColumnsArgs
            {
                DatabaseName = "string",
                Name = "string",
                CatalogId = "string",
                ColumnNames = new[]
                {
                    "string",
                },
                ColumnWildcard = new Aws.LakeFormation.Inputs.OptInResourceDataTableWithColumnsColumnWildcardArgs
                {
                    ExcludedColumnNames = new[]
                    {
                        "string",
                    },
                },
            },
        },
    },
});

    example, err := lakeformation.NewOptIn(ctx, "optInResource", &lakeformation.OptInArgs{
	Conditions: lakeformation.OptInConditionArray{
		&lakeformation.OptInConditionArgs{
			Expression: pulumi.String("string"),
		},
	},
	Principals: lakeformation.OptInPrincipalArray{
		&lakeformation.OptInPrincipalArgs{
			DataLakePrincipalIdentifier: pulumi.String("string"),
		},
	},
	ResourceDatas: lakeformation.OptInResourceDataArray{
		&lakeformation.OptInResourceDataArgs{
			Catalogs: lakeformation.OptInResourceDataCatalogArray{
				&lakeformation.OptInResourceDataCatalogArgs{
					Id: pulumi.String("string"),
				},
			},
			DataCellsFilters: lakeformation.OptInResourceDataDataCellsFilterArray{
				&lakeformation.OptInResourceDataDataCellsFilterArgs{
					DatabaseName:   pulumi.String("string"),
					Name:           pulumi.String("string"),
					TableCatalogId: pulumi.String("string"),
					TableName:      pulumi.String("string"),
				},
			},
			DataLocations: lakeformation.OptInResourceDataDataLocationArray{
				&lakeformation.OptInResourceDataDataLocationArgs{
					ResourceArn: pulumi.String("string"),
					CatalogId:   pulumi.String("string"),
				},
			},
			Database: &lakeformation.OptInResourceDataDatabaseArgs{
				Name:      pulumi.String("string"),
				CatalogId: pulumi.String("string"),
			},
			LfTag: &lakeformation.OptInResourceDataLfTagArgs{
				Key:       pulumi.String("string"),
				Value:     pulumi.String("string"),
				CatalogId: pulumi.String("string"),
			},
			LfTagExpressions: lakeformation.OptInResourceDataLfTagExpressionArray{
				&lakeformation.OptInResourceDataLfTagExpressionArgs{
					Name:      pulumi.String("string"),
					CatalogId: pulumi.String("string"),
				},
			},
			LfTagPolicies: lakeformation.OptInResourceDataLfTagPolicyArray{
				&lakeformation.OptInResourceDataLfTagPolicyArgs{
					ResourceType:   pulumi.String("string"),
					CatalogId:      pulumi.String("string"),
					ExpressionName: pulumi.String("string"),
					Expressions: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			Table: &lakeformation.OptInResourceDataTableArgs{
				DatabaseName: pulumi.String("string"),
				CatalogId:    pulumi.String("string"),
				Name:         pulumi.String("string"),
				Wildcard:     pulumi.Bool(false),
			},
			TableWithColumns: &lakeformation.OptInResourceDataTableWithColumnsArgs{
				DatabaseName: pulumi.String("string"),
				Name:         pulumi.String("string"),
				CatalogId:    pulumi.String("string"),
				ColumnNames: pulumi.StringArray{
					pulumi.String("string"),
				},
				ColumnWildcard: &lakeformation.OptInResourceDataTableWithColumnsColumnWildcardArgs{
					ExcludedColumnNames: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
	},
})

    var optInResource = new OptIn("optInResource", OptInArgs.builder()
    .conditions(OptInConditionArgs.builder()
        .expression("string")
        .build())
    .principals(OptInPrincipalArgs.builder()
        .dataLakePrincipalIdentifier("string")
        .build())
    .resourceDatas(OptInResourceDataArgs.builder()
        .catalogs(OptInResourceDataCatalogArgs.builder()
            .id("string")
            .build())
        .dataCellsFilters(OptInResourceDataDataCellsFilterArgs.builder()
            .databaseName("string")
            .name("string")
            .tableCatalogId("string")
            .tableName("string")
            .build())
        .dataLocations(OptInResourceDataDataLocationArgs.builder()
            .resourceArn("string")
            .catalogId("string")
            .build())
        .database(OptInResourceDataDatabaseArgs.builder()
            .name("string")
            .catalogId("string")
            .build())
        .lfTag(OptInResourceDataLfTagArgs.builder()
            .key("string")
            .value("string")
            .catalogId("string")
            .build())
        .lfTagExpressions(OptInResourceDataLfTagExpressionArgs.builder()
            .name("string")
            .catalogId("string")
            .build())
        .lfTagPolicies(OptInResourceDataLfTagPolicyArgs.builder()
            .resourceType("string")
            .catalogId("string")
            .expressionName("string")
            .expressions("string")
            .build())
        .table(OptInResourceDataTableArgs.builder()
            .databaseName("string")
            .catalogId("string")
            .name("string")
            .wildcard(false)
            .build())
        .tableWithColumns(OptInResourceDataTableWithColumnsArgs.builder()
            .databaseName("string")
            .name("string")
            .catalogId("string")
            .columnNames("string")
            .columnWildcard(OptInResourceDataTableWithColumnsColumnWildcardArgs.builder()
                .excludedColumnNames("string")
                .build())
            .build())
        .build())
    .build());

    opt_in_resource = aws.lakeformation.OptIn("optInResource",
    conditions=[{
        "expression": "string",
    }],
    principals=[{
        "data_lake_principal_identifier": "string",
    }],
    resource_datas=[{
        "catalogs": [{
            "id": "string",
        }],
        "data_cells_filters": [{
            "database_name": "string",
            "name": "string",
            "table_catalog_id": "string",
            "table_name": "string",
        }],
        "data_locations": [{
            "resource_arn": "string",
            "catalog_id": "string",
        }],
        "database": {
            "name": "string",
            "catalog_id": "string",
        },
        "lf_tag": {
            "key": "string",
            "value": "string",
            "catalog_id": "string",
        },
        "lf_tag_expressions": [{
            "name": "string",
            "catalog_id": "string",
        }],
        "lf_tag_policies": [{
            "resource_type": "string",
            "catalog_id": "string",
            "expression_name": "string",
            "expressions": ["string"],
        }],
        "table": {
            "database_name": "string",
            "catalog_id": "string",
            "name": "string",
            "wildcard": False,
        },
        "table_with_columns": {
            "database_name": "string",
            "name": "string",
            "catalog_id": "string",
            "column_names": ["string"],
            "column_wildcard": {
                "excluded_column_names": ["string"],
            },
        },
    }])

    const optInResource = new aws.lakeformation.OptIn("optInResource", {
    conditions: [{
        expression: "string",
    }],
    principals: [{
        dataLakePrincipalIdentifier: "string",
    }],
    resourceDatas: [{
        catalogs: [{
            id: "string",
        }],
        dataCellsFilters: [{
            databaseName: "string",
            name: "string",
            tableCatalogId: "string",
            tableName: "string",
        }],
        dataLocations: [{
            resourceArn: "string",
            catalogId: "string",
        }],
        database: {
            name: "string",
            catalogId: "string",
        },
        lfTag: {
            key: "string",
            value: "string",
            catalogId: "string",
        },
        lfTagExpressions: [{
            name: "string",
            catalogId: "string",
        }],
        lfTagPolicies: [{
            resourceType: "string",
            catalogId: "string",
            expressionName: "string",
            expressions: ["string"],
        }],
        table: {
            databaseName: "string",
            catalogId: "string",
            name: "string",
            wildcard: false,
        },
        tableWithColumns: {
            databaseName: "string",
            name: "string",
            catalogId: "string",
            columnNames: ["string"],
            columnWildcard: {
                excludedColumnNames: ["string"],
            },
        },
    }],
});

    type: aws:lakeformation:OptIn
properties:
    conditions:
        - expression: string
    principals:
        - dataLakePrincipalIdentifier: string
    resourceDatas:
        - catalogs:
            - id: string
          dataCellsFilters:
            - databaseName: string
              name: string
              tableCatalogId: string
              tableName: string
          dataLocations:
            - catalogId: string
              resourceArn: string
          database:
            catalogId: string
            name: string
          lfTag:
            catalogId: string
            key: string
            value: string
          lfTagExpressions:
            - catalogId: string
              name: string
          lfTagPolicies:
            - catalogId: string
              expressionName: string
              expressions:
                - string
              resourceType: string
          table:
            catalogId: string
            databaseName: string
            name: string
            wildcard: false
          tableWithColumns:
            catalogId: string
            columnNames:
                - string
            columnWildcard:
                excludedColumnNames:
                    - string
            databaseName: string
            name: string

    OptIn Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OptIn resource accepts the following input properties:

    Conditions List<OptInCondition>
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    Principals List<OptInPrincipal>
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    ResourceDatas List<OptInResourceData>
    Structure for the resource. See Resource for more details.
    Conditions []OptInConditionArgs
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    Principals []OptInPrincipalArgs
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    ResourceDatas []OptInResourceDataArgs
    Structure for the resource. See Resource for more details.
    conditions List<OptInCondition>
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    principals List<OptInPrincipal>
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    resourceDatas List<OptInResourceData>
    Structure for the resource. See Resource for more details.
    conditions OptInCondition[]
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    principals OptInPrincipal[]
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    resourceDatas OptInResourceData[]
    Structure for the resource. See Resource for more details.
    conditions Sequence[OptInConditionArgs]
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    principals Sequence[OptInPrincipalArgs]
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    resource_datas Sequence[OptInResourceDataArgs]
    Structure for the resource. See Resource for more details.
    conditions List<Property Map>
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    principals List<Property Map>
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    resourceDatas List<Property Map>
    Structure for the resource. See Resource for more details.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OptIn resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LastModified string
    Last modified date and time of the record.
    LastUpdatedBy string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModified string
    Last modified date and time of the record.
    LastUpdatedBy string
    id String
    The provider-assigned unique ID for this managed resource.
    lastModified String
    Last modified date and time of the record.
    lastUpdatedBy String
    id string
    The provider-assigned unique ID for this managed resource.
    lastModified string
    Last modified date and time of the record.
    lastUpdatedBy string
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified str
    Last modified date and time of the record.
    last_updated_by str
    id String
    The provider-assigned unique ID for this managed resource.
    lastModified String
    Last modified date and time of the record.
    lastUpdatedBy String

    Look up Existing OptIn Resource

    Get an existing OptIn resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OptInState, opts?: CustomResourceOptions): OptIn
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        conditions: Optional[Sequence[OptInConditionArgs]] = None,
        last_modified: Optional[str] = None,
        last_updated_by: Optional[str] = None,
        principals: Optional[Sequence[OptInPrincipalArgs]] = None,
        resource_datas: Optional[Sequence[OptInResourceDataArgs]] = None) -> OptIn
    func GetOptIn(ctx *Context, name string, id IDInput, state *OptInState, opts ...ResourceOption) (*OptIn, error)
    public static OptIn Get(string name, Input<string> id, OptInState? state, CustomResourceOptions? opts = null)
    public static OptIn get(String name, Output<String> id, OptInState state, CustomResourceOptions options)
    resources:  _:    type: aws:lakeformation:OptIn    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Conditions List<OptInCondition>
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    LastModified string
    Last modified date and time of the record.
    LastUpdatedBy string
    Principals List<OptInPrincipal>
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    ResourceDatas List<OptInResourceData>
    Structure for the resource. See Resource for more details.
    Conditions []OptInConditionArgs
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    LastModified string
    Last modified date and time of the record.
    LastUpdatedBy string
    Principals []OptInPrincipalArgs
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    ResourceDatas []OptInResourceDataArgs
    Structure for the resource. See Resource for more details.
    conditions List<OptInCondition>
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    lastModified String
    Last modified date and time of the record.
    lastUpdatedBy String
    principals List<OptInPrincipal>
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    resourceDatas List<OptInResourceData>
    Structure for the resource. See Resource for more details.
    conditions OptInCondition[]
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    lastModified string
    Last modified date and time of the record.
    lastUpdatedBy string
    principals OptInPrincipal[]
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    resourceDatas OptInResourceData[]
    Structure for the resource. See Resource for more details.
    conditions Sequence[OptInConditionArgs]
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    last_modified str
    Last modified date and time of the record.
    last_updated_by str
    principals Sequence[OptInPrincipalArgs]
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    resource_datas Sequence[OptInResourceDataArgs]
    Structure for the resource. See Resource for more details.
    conditions List<Property Map>
    Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    lastModified String
    Last modified date and time of the record.
    lastUpdatedBy String
    principals List<Property Map>
    Lake Formation principal. Supported principals are IAM users or IAM roles. See Principal for more details.
    resourceDatas List<Property Map>
    Structure for the resource. See Resource for more details.

    Supporting Types

    OptInCondition, OptInConditionArgs

    Expression string
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    Expression string
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    expression String
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    expression string
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    expression str
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    expression String
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.

    OptInPrincipal, OptInPrincipalArgs

    OptInResourceData, OptInResourceDataArgs

    Catalogs List<OptInResourceDataCatalog>
    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. See Catalog for more details.
    DataCellsFilters List<OptInResourceDataDataCellsFilter>
    Data cell filter. See Data Cells Filter for more details.
    DataLocations List<OptInResourceDataDataLocation>
    Location of an Amazon S3 path where permissions are granted or revoked. See Data Location for more details.
    Database OptInResourceDataDatabase
    Database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. See Database for more details.
    LfTag OptInResourceDataLfTag
    LF-tag key and values attached to a resource.
    LfTagExpressions List<OptInResourceDataLfTagExpression>
    Logical expression composed of one or more LF-Tag key:value pairs. See LF-Tag Expression for more details.
    LfTagPolicies List<OptInResourceDataLfTagPolicy>
    List of LF-Tag conditions or saved LF-Tag expressions that define a resource's LF-Tag policy. See LF-Tag Policy for more details.
    Table OptInResourceDataTable
    Table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. See Table for more details.
    TableWithColumns OptInResourceDataTableWithColumns
    Table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3. See Table With Columns for more details.
    Catalogs []OptInResourceDataCatalog
    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. See Catalog for more details.
    DataCellsFilters []OptInResourceDataDataCellsFilter
    Data cell filter. See Data Cells Filter for more details.
    DataLocations []OptInResourceDataDataLocation
    Location of an Amazon S3 path where permissions are granted or revoked. See Data Location for more details.
    Database OptInResourceDataDatabase
    Database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. See Database for more details.
    LfTag OptInResourceDataLfTag
    LF-tag key and values attached to a resource.
    LfTagExpressions []OptInResourceDataLfTagExpression
    Logical expression composed of one or more LF-Tag key:value pairs. See LF-Tag Expression for more details.
    LfTagPolicies []OptInResourceDataLfTagPolicy
    List of LF-Tag conditions or saved LF-Tag expressions that define a resource's LF-Tag policy. See LF-Tag Policy for more details.
    Table OptInResourceDataTable
    Table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. See Table for more details.
    TableWithColumns OptInResourceDataTableWithColumns
    Table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3. See Table With Columns for more details.
    catalogs List<OptInResourceDataCatalog>
    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. See Catalog for more details.
    dataCellsFilters List<OptInResourceDataDataCellsFilter>
    Data cell filter. See Data Cells Filter for more details.
    dataLocations List<OptInResourceDataDataLocation>
    Location of an Amazon S3 path where permissions are granted or revoked. See Data Location for more details.
    database OptInResourceDataDatabase
    Database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. See Database for more details.
    lfTag OptInResourceDataLfTag
    LF-tag key and values attached to a resource.
    lfTagExpressions List<OptInResourceDataLfTagExpression>
    Logical expression composed of one or more LF-Tag key:value pairs. See LF-Tag Expression for more details.
    lfTagPolicies List<OptInResourceDataLfTagPolicy>
    List of LF-Tag conditions or saved LF-Tag expressions that define a resource's LF-Tag policy. See LF-Tag Policy for more details.
    table OptInResourceDataTable
    Table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. See Table for more details.
    tableWithColumns OptInResourceDataTableWithColumns
    Table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3. See Table With Columns for more details.
    catalogs OptInResourceDataCatalog[]
    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. See Catalog for more details.
    dataCellsFilters OptInResourceDataDataCellsFilter[]
    Data cell filter. See Data Cells Filter for more details.
    dataLocations OptInResourceDataDataLocation[]
    Location of an Amazon S3 path where permissions are granted or revoked. See Data Location for more details.
    database OptInResourceDataDatabase
    Database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. See Database for more details.
    lfTag OptInResourceDataLfTag
    LF-tag key and values attached to a resource.
    lfTagExpressions OptInResourceDataLfTagExpression[]
    Logical expression composed of one or more LF-Tag key:value pairs. See LF-Tag Expression for more details.
    lfTagPolicies OptInResourceDataLfTagPolicy[]
    List of LF-Tag conditions or saved LF-Tag expressions that define a resource's LF-Tag policy. See LF-Tag Policy for more details.
    table OptInResourceDataTable
    Table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. See Table for more details.
    tableWithColumns OptInResourceDataTableWithColumns
    Table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3. See Table With Columns for more details.
    catalogs Sequence[OptInResourceDataCatalog]
    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. See Catalog for more details.
    data_cells_filters Sequence[OptInResourceDataDataCellsFilter]
    Data cell filter. See Data Cells Filter for more details.
    data_locations Sequence[OptInResourceDataDataLocation]
    Location of an Amazon S3 path where permissions are granted or revoked. See Data Location for more details.
    database OptInResourceDataDatabase
    Database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. See Database for more details.
    lf_tag OptInResourceDataLfTag
    LF-tag key and values attached to a resource.
    lf_tag_expressions Sequence[OptInResourceDataLfTagExpression]
    Logical expression composed of one or more LF-Tag key:value pairs. See LF-Tag Expression for more details.
    lf_tag_policies Sequence[OptInResourceDataLfTagPolicy]
    List of LF-Tag conditions or saved LF-Tag expressions that define a resource's LF-Tag policy. See LF-Tag Policy for more details.
    table OptInResourceDataTable
    Table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. See Table for more details.
    table_with_columns OptInResourceDataTableWithColumns
    Table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3. See Table With Columns for more details.
    catalogs List<Property Map>
    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. See Catalog for more details.
    dataCellsFilters List<Property Map>
    Data cell filter. See Data Cells Filter for more details.
    dataLocations List<Property Map>
    Location of an Amazon S3 path where permissions are granted or revoked. See Data Location for more details.
    database Property Map
    Database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. See Database for more details.
    lfTag Property Map
    LF-tag key and values attached to a resource.
    lfTagExpressions List<Property Map>
    Logical expression composed of one or more LF-Tag key:value pairs. See LF-Tag Expression for more details.
    lfTagPolicies List<Property Map>
    List of LF-Tag conditions or saved LF-Tag expressions that define a resource's LF-Tag policy. See LF-Tag Policy for more details.
    table Property Map
    Table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. See Table for more details.
    tableWithColumns Property Map
    Table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3. See Table With Columns for more details.

    OptInResourceDataCatalog, OptInResourceDataCatalogArgs

    Id string
    Identifier for the catalog resource.
    Id string
    Identifier for the catalog resource.
    id String
    Identifier for the catalog resource.
    id string
    Identifier for the catalog resource.
    id str
    Identifier for the catalog resource.
    id String
    Identifier for the catalog resource.

    OptInResourceDataDataCellsFilter, OptInResourceDataDataCellsFilterArgs

    DatabaseName string
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    Name string
    Name of the table.
    TableCatalogId string
    ID of the catalog to which the table belongs.
    TableName string
    Name of the table.
    DatabaseName string
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    Name string
    Name of the table.
    TableCatalogId string
    ID of the catalog to which the table belongs.
    TableName string
    Name of the table.
    databaseName String
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    name String
    Name of the table.
    tableCatalogId String
    ID of the catalog to which the table belongs.
    tableName String
    Name of the table.
    databaseName string
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    name string
    Name of the table.
    tableCatalogId string
    ID of the catalog to which the table belongs.
    tableName string
    Name of the table.
    database_name str
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    name str
    Name of the table.
    table_catalog_id str
    ID of the catalog to which the table belongs.
    table_name str
    Name of the table.
    databaseName String
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    name String
    Name of the table.
    tableCatalogId String
    ID of the catalog to which the table belongs.
    tableName String
    Name of the table.

    OptInResourceDataDataLocation, OptInResourceDataDataLocationArgs

    ResourceArn string
    ARN that uniquely identifies the data location resource.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    ResourceArn string
    ARN that uniquely identifies the data location resource.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    resourceArn String
    ARN that uniquely identifies the data location resource.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    resourceArn string
    ARN that uniquely identifies the data location resource.
    catalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    resource_arn str
    ARN that uniquely identifies the data location resource.
    catalog_id str
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    resourceArn String
    ARN that uniquely identifies the data location resource.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.

    OptInResourceDataDatabase, OptInResourceDataDatabaseArgs

    Name string
    Name of the table.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    Name string
    Name of the table.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name String
    Name of the table.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name string
    Name of the table.
    catalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name str
    Name of the table.
    catalog_id str
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name String
    Name of the table.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.

    OptInResourceDataLfTag, OptInResourceDataLfTagArgs

    Key string
    Value string
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    Key string
    Value string
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    key String
    value String
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    key string
    value string
    catalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    key str
    value str
    catalog_id str
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    key String
    value String
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.

    OptInResourceDataLfTagExpression, OptInResourceDataLfTagExpressionArgs

    Name string
    Name of the table.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    Name string
    Name of the table.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name String
    Name of the table.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name string
    Name of the table.
    catalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name str
    Name of the table.
    catalog_id str
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name String
    Name of the table.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.

    OptInResourceDataLfTagPolicy, OptInResourceDataLfTagPolicyArgs

    ResourceType string
    Resource type for which the LF-tag policy applies.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    ExpressionName string
    If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName .
    Expressions List<string>
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    ResourceType string
    Resource type for which the LF-tag policy applies.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    ExpressionName string
    If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName .
    Expressions []string
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    resourceType String
    Resource type for which the LF-tag policy applies.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    expressionName String
    If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName .
    expressions List<String>
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    resourceType string
    Resource type for which the LF-tag policy applies.
    catalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    expressionName string
    If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName .
    expressions string[]
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    resource_type str
    Resource type for which the LF-tag policy applies.
    catalog_id str
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    expression_name str
    If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName .
    expressions Sequence[str]
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.
    resourceType String
    Resource type for which the LF-tag policy applies.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    expressionName String
    If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName .
    expressions List<String>
    List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.

    OptInResourceDataTable, OptInResourceDataTableArgs

    DatabaseName string
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    Name string
    Name of the table.
    Wildcard bool
    DatabaseName string
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    Name string
    Name of the table.
    Wildcard bool
    databaseName String
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name String
    Name of the table.
    wildcard Boolean
    databaseName string
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    catalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name string
    Name of the table.
    wildcard boolean
    database_name str
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    catalog_id str
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name str
    Name of the table.
    wildcard bool
    databaseName String
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    name String
    Name of the table.
    wildcard Boolean

    OptInResourceDataTableWithColumns, OptInResourceDataTableWithColumnsArgs

    DatabaseName string
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    Name string
    Name of the table.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    ColumnNames List<string>
    List of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
    ColumnWildcard OptInResourceDataTableWithColumnsColumnWildcard
    Wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.
    DatabaseName string
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    Name string
    Name of the table.
    CatalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    ColumnNames []string
    List of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
    ColumnWildcard OptInResourceDataTableWithColumnsColumnWildcard
    Wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.
    databaseName String
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    name String
    Name of the table.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    columnNames List<String>
    List of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
    columnWildcard OptInResourceDataTableWithColumnsColumnWildcard
    Wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.
    databaseName string
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    name string
    Name of the table.
    catalogId string
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    columnNames string[]
    List of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
    columnWildcard OptInResourceDataTableWithColumnsColumnWildcard
    Wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.
    database_name str
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    name str
    Name of the table.
    catalog_id str
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    column_names Sequence[str]
    List of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
    column_wildcard OptInResourceDataTableWithColumnsColumnWildcard
    Wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.
    databaseName String
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
    name String
    Name of the table.
    catalogId String
    Identifier for the Data Catalog. By default, it is the account ID of the caller.
    columnNames List<String>
    List of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
    columnWildcard Property Map
    Wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

    OptInResourceDataTableWithColumnsColumnWildcard, OptInResourceDataTableWithColumnsColumnWildcardArgs

    ExcludedColumnNames List<string>
    excludedColumnNames List<String>
    excluded_column_names Sequence[str]
    excludedColumnNames List<String>

    Import

    Using pulumi import, import Lake Formation Opt In using the example_id_arg. For example:

    $ pulumi import aws:lakeformation/optIn:OptIn example opt_in-id-12345678

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws