TableBucketPolicy class

Resource for managing an Amazon S3 Tables Table Bucket Policy.

Example Usage

Basic Usage

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

const example = aws.iam.getPolicyDocument({
    statements: [{}],
});
const exampleTableBucket = new aws.s3tables.TableBucket("example", {name: "example-bucket"});
const exampleTableBucketPolicy = new aws.s3tables.TableBucketPolicy("example", {
    resourcePolicy: example.then(example => example.json),
    tableBucketArn: exampleTableBucket.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.iam.get_policy_document(statements=[{}])
example_table_bucket = aws.s3tables.TableBucket("example", name="example-bucket")
example_table_bucket_policy = aws.s3tables.TableBucketPolicy("example",
    resource_policy=example.json,
    table_bucket_arn=example_table_bucket.arn)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            null,
        },
    });

    var exampleTableBucket = new Aws.S3Tables.TableBucket("example", new()
    {
        Name = "example-bucket",
    });

    var exampleTableBucketPolicy = new Aws.S3Tables.TableBucketPolicy("example", new()
    {
        ResourcePolicy = example.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
        TableBucketArn = exampleTableBucket.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3tables"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{},
			},
		}, nil)
		if err != nil {
			return err
		}
		exampleTableBucket, err := s3tables.NewTableBucket(ctx, "example", &s3tables.TableBucketArgs{
			Name: pulumi.String("example-bucket"),
		})
		if err != nil {
			return err
		}
		_, err = s3tables.NewTableBucketPolicy(ctx, "example", &s3tables.TableBucketPolicyArgs{
			ResourcePolicy: pulumi.String(example.Json),
			TableBucketArn: exampleTableBucket.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_iam_getpolicydocument" "example" {
  statements {
  }
}

resource "aws_s3tables_tablebucketpolicy" "example" {
  resource_policy  = data.aws_iam_getpolicydocument.example.json
  table_bucket_arn = aws_s3tables_tablebucket.example.arn
}
resource "aws_s3tables_tablebucket" "example" {
  name = "example-bucket"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
import com.pulumi.aws.s3tables.TableBucket;
import com.pulumi.aws.s3tables.TableBucketArgs;
import com.pulumi.aws.s3tables.TableBucketPolicy;
import com.pulumi.aws.s3tables.TableBucketPolicyArgs;
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) {
        final var example = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .build())
            .build());

        var exampleTableBucket = new TableBucket("exampleTableBucket", TableBucketArgs.builder()
            .name("example-bucket")
            .build());

        var exampleTableBucketPolicy = new TableBucketPolicy("exampleTableBucketPolicy", TableBucketPolicyArgs.builder()
            .resourcePolicy(example.json())
            .tableBucketArn(exampleTableBucket.arn())
            .build());

    }
}
resources:
  exampleTableBucketPolicy:
    type: aws:s3tables:TableBucketPolicy
    name: example
    properties:
      resourcePolicy: ${example.json}
      tableBucketArn: ${exampleTableBucket.arn}
  exampleTableBucket:
    type: aws:s3tables:TableBucket
    name: example
    properties:
      name: example-bucket
variables:
  example:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - {}

Import

Identity Schema

Required

  • tableBucketArn (String) ARN of the S3 Tables Table Bucket.

Using pulumi import, import S3 Tables Table Bucket Policy using the tableBucketArn. For example:

$ pulumi import aws:s3tables/tableBucketPolicy:TableBucketPolicy example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace'

Constructors

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

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
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
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourcePolicy ↔ Output<String>
Amazon Web Services resource-based policy document in JSON format.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tableBucketArn ↔ Output<String>
ARN referencing the Table Bucket that owns this policy.
latefinal
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, {TableBucketPolicyState? state, CustomResourceOptions? options}) → TableBucketPolicy
Gets an existing TableBucketPolicy resource's state with the given name and id.