OptIn class

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", {
    principals: [{
        dataLakePrincipalIdentifier: exampleAwsIamRole.arn,
    }],
    resourceDatas: [{
        database: {
            name: exampleAwsGlueCatalogDatabase.name,
            catalogId: current.accountId,
        },
    }],
});
import pulumi
import pulumi_aws as aws

example = aws.lakeformation.OptIn("example",
    principals=[{
        "data_lake_principal_identifier": example_aws_iam_role["arn"],
    }],
    resource_datas=[{
        "database": {
            "name": example_aws_glue_catalog_database["name"],
            "catalog_id": current["accountId"],
        },
    }])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.LakeFormation.OptIn("example", new()
    {
        Principals = new[]
        {
            new Aws.LakeFormation.Inputs.OptInPrincipalArgs
            {
                DataLakePrincipalIdentifier = exampleAwsIamRole.Arn,
            },
        },
        ResourceDatas = new[]
        {
            new Aws.LakeFormation.Inputs.OptInResourceDataArgs
            {
                Database = new Aws.LakeFormation.Inputs.OptInResourceDataDatabaseArgs
                {
                    Name = exampleAwsGlueCatalogDatabase.Name,
                    CatalogId = current.AccountId,
                },
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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", &lakeformation.OptInArgs{
			Principals: lakeformation.OptInPrincipalArray{
				&lakeformation.OptInPrincipalArgs{
					DataLakePrincipalIdentifier: pulumi.Any(exampleAwsIamRole.Arn),
				},
			},
			ResourceDatas: lakeformation.OptInResourceDataArray{
				&lakeformation.OptInResourceDataArgs{
					Database: &lakeformation.OptInResourceDataDatabaseArgs{
						Name:      pulumi.Any(exampleAwsGlueCatalogDatabase.Name),
						CatalogId: pulumi.Any(current.AccountId),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lakeformation_optin" "example" {
  principals {
    data_lake_principal_identifier = exampleAwsIamRole.arn
  }
  resource_datas {
    database = {
      name       = exampleAwsGlueCatalogDatabase.name
      catalog_id = current.accountId
    }
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lakeformation.OptIn;
import com.pulumi.aws.lakeformation.OptInArgs;
import com.pulumi.aws.lakeformation.inputs.OptInPrincipalArgs;
import com.pulumi.aws.lakeformation.inputs.OptInResourceDataArgs;
import com.pulumi.aws.lakeformation.inputs.OptInResourceDataDatabaseArgs;
import java.util.ArrayList;
import java.util.Arrays;
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", OptInArgs.builder()
            .principals(OptInPrincipalArgs.builder()
                .dataLakePrincipalIdentifier(exampleAwsIamRole.arn())
                .build())
            .resourceDatas(OptInResourceDataArgs.builder()
                .database(OptInResourceDataDatabaseArgs.builder()
                    .name(exampleAwsGlueCatalogDatabase.name())
                    .catalogId(current.accountId())
                    .build())
                .build())
            .build());

    }
}
resources:
  example:
    type: aws:lakeformation:OptIn
    properties:
      principals:
        - dataLakePrincipalIdentifier: ${exampleAwsIamRole.arn}
      resourceDatas:
        - database:
            name: ${exampleAwsGlueCatalogDatabase.name}
            catalogId: ${current.accountId}

Constructors

OptIn(String name, {OptInArgs? args, CustomResourceOptions? options})
Creates a new OptIn. name The Pulumi resource name. args Arguments used to configure this OptIn. The set of arguments for OptIn. options Resource options controlling this resource's behavior.
OptIn.reference(String urn)
Creates a typed reference to an existing OptIn resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
conditions ↔ Output<List<OptInCondition>?>
Lake Formation condition, which applies to permissions and opt-ins that contain an expression. See condition Block for more details.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
lastModified ↔ Output<String>
Last modified date and time of the record.
latefinal
lastUpdatedBy ↔ Output<String>
User who updated the record.
latefinal
principals ↔ Output<List<OptInPrincipal>>
Lake Formation principal. Supported principals are IAM users or IAM roles. See principal Block for more details.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceDatas ↔ Output<List<OptInResourceData>?>
Structure for the resource. See resourceData Block for more details.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {OptInState? state, CustomResourceOptions? options}) → OptIn
Gets an existing OptIn resource's state with the given name and id.