ResourcePolicy class

Resource for managing an AWS DynamoDB Resource Policy.

Example Usage

Basic Usage

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

const example = new aws.dynamodb.ResourcePolicy("example", {
    resourceArn: exampleAwsDynamodbTable.arn,
    policy: test.json,
});
import pulumi
import pulumi_aws as aws

example = aws.dynamodb.ResourcePolicy("example",
    resource_arn=example_aws_dynamodb_table["arn"],
    policy=test["json"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.DynamoDB.ResourcePolicy("example", new()
    {
        ResourceArn = exampleAwsDynamodbTable.Arn,
        Policy = test.Json,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dynamodb.NewResourcePolicy(ctx, "example", &dynamodb.ResourcePolicyArgs{
			ResourceArn: pulumi.Any(exampleAwsDynamodbTable.Arn),
			Policy:      pulumi.Any(test.Json),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_dynamodb_resourcepolicy" "example" {
  resource_arn = exampleAwsDynamodbTable.arn
  policy       = test.json
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dynamodb.ResourcePolicy;
import com.pulumi.aws.dynamodb.ResourcePolicyArgs;
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 ResourcePolicy("example", ResourcePolicyArgs.builder()
            .resourceArn(exampleAwsDynamodbTable.arn())
            .policy(test.json())
            .build());

    }
}
resources:
  example:
    type: aws:dynamodb:ResourcePolicy
    properties:
      resourceArn: ${exampleAwsDynamodbTable.arn}
      policy: ${test.json}

Import

Identity Schema

Required

  • resourceArn (String) ARN of the DynamoDB table.

Using pulumi import, import DynamoDB Resource Policy using the resourceArn. For example:

$ pulumi import aws:dynamodb/resourcePolicy:ResourcePolicy example arn:aws:dynamodb:us-east-1:1234567890:table/my-table

Constructors

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

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
confirmRemoveSelfResourceAccess ↔ Output<bool>
Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future.
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
policy ↔ Output<String>
n Amazon Web Services resource-based policy document in JSON format. The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceArn ↔ Output<String>
ARN of the DynamoDB resource to which the policy will be attached. The resources you can specify include tables and streams. You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index ARNs in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
revisionId ↔ Output<String>
A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
latefinal
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, {ResourcePolicyState? state, CustomResourceOptions? options}) → ResourcePolicy
Gets an existing ResourcePolicy resource's state with the given name and id.