AWS Classic

v5.16.2 published on Tuesday, Oct 4, 2022 by Pulumi

BucketPolicy

Provides a resource to manage an S3 Control Bucket Policy.

This functionality is for managing S3 on Outposts. To manage S3 Bucket Policies in an AWS Partition, see the aws.s3.BucketPolicy resource.

Example Usage

using System.Collections.Generic;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.S3Control.BucketPolicy("example", new()
    {
        Bucket = aws_s3control_bucket.Example.Arn,
        Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Id"] = "testBucketPolicy",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Action"] = "s3-outposts:PutBucketLifecycleConfiguration",
                    ["Effect"] = "Deny",
                    ["Principal"] = new Dictionary<string, object?>
                    {
                        ["AWS"] = "*",
                    },
                    ["Resource"] = aws_s3control_bucket.Example.Arn,
                    ["Sid"] = "statement1",
                },
            },
            ["Version"] = "2012-10-17",
        }),
    });

});
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/s3control"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Id": "testBucketPolicy",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Action": "s3-outposts:PutBucketLifecycleConfiguration",
					"Effect": "Deny",
					"Principal": map[string]interface{}{
						"AWS": "*",
					},
					"Resource": aws_s3control_bucket.Example.Arn,
					"Sid":      "statement1",
				},
			},
			"Version": "2012-10-17",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = s3control.NewBucketPolicy(ctx, "example", &s3control.BucketPolicyArgs{
			Bucket: pulumi.Any(aws_s3control_bucket.Example.Arn),
			Policy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3control.BucketPolicy;
import com.pulumi.aws.s3control.BucketPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 BucketPolicy("example", BucketPolicyArgs.builder()        
            .bucket(aws_s3control_bucket.example().arn())
            .policy(serializeJson(
                jsonObject(
                    jsonProperty("Id", "testBucketPolicy"),
                    jsonProperty("Statement", jsonArray(jsonObject(
                        jsonProperty("Action", "s3-outposts:PutBucketLifecycleConfiguration"),
                        jsonProperty("Effect", "Deny"),
                        jsonProperty("Principal", jsonObject(
                            jsonProperty("AWS", "*")
                        )),
                        jsonProperty("Resource", aws_s3control_bucket.example().arn()),
                        jsonProperty("Sid", "statement1")
                    ))),
                    jsonProperty("Version", "2012-10-17")
                )))
            .build());

    }
}
import pulumi
import json
import pulumi_aws as aws

example = aws.s3control.BucketPolicy("example",
    bucket=aws_s3control_bucket["example"]["arn"],
    policy=json.dumps({
        "Id": "testBucketPolicy",
        "Statement": [{
            "Action": "s3-outposts:PutBucketLifecycleConfiguration",
            "Effect": "Deny",
            "Principal": {
                "AWS": "*",
            },
            "Resource": aws_s3control_bucket["example"]["arn"],
            "Sid": "statement1",
        }],
        "Version": "2012-10-17",
    }))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3control.BucketPolicy("example", {
    bucket: aws_s3control_bucket.example.arn,
    policy: JSON.stringify({
        Id: "testBucketPolicy",
        Statement: [{
            Action: "s3-outposts:PutBucketLifecycleConfiguration",
            Effect: "Deny",
            Principal: {
                AWS: "*",
            },
            Resource: aws_s3control_bucket.example.arn,
            Sid: "statement1",
        }],
        Version: "2012-10-17",
    }),
});
resources:
  example:
    type: aws:s3control:BucketPolicy
    properties:
      bucket: ${aws_s3control_bucket.example.arn}
      policy:
        Fn::ToJSON:
          Id: testBucketPolicy
          Statement:
            - Action: s3-outposts:PutBucketLifecycleConfiguration
              Effect: Deny
              Principal:
                AWS: '*'
              Resource: ${aws_s3control_bucket.example.arn}
              Sid: statement1
          Version: 2012-10-17

Create a BucketPolicy Resource

new BucketPolicy(name: string, args: BucketPolicyArgs, opts?: CustomResourceOptions);
@overload
def BucketPolicy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 bucket: Optional[str] = None,
                 policy: Optional[str] = None)
@overload
def BucketPolicy(resource_name: str,
                 args: BucketPolicyArgs,
                 opts: Optional[ResourceOptions] = None)
func NewBucketPolicy(ctx *Context, name string, args BucketPolicyArgs, opts ...ResourceOption) (*BucketPolicy, error)
public BucketPolicy(string name, BucketPolicyArgs args, CustomResourceOptions? opts = null)
public BucketPolicy(String name, BucketPolicyArgs args)
public BucketPolicy(String name, BucketPolicyArgs args, CustomResourceOptions options)
type: aws:s3control:BucketPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args BucketPolicyArgs
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 BucketPolicyArgs
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 BucketPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BucketPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BucketPolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BucketPolicy Resource Properties

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

Inputs

The BucketPolicy resource accepts the following input properties:

Bucket string

Amazon Resource Name (ARN) of the bucket.

Policy string

JSON string of the resource policy.

Bucket string

Amazon Resource Name (ARN) of the bucket.

Policy string

JSON string of the resource policy.

bucket String

Amazon Resource Name (ARN) of the bucket.

policy String

JSON string of the resource policy.

bucket string

Amazon Resource Name (ARN) of the bucket.

policy string

JSON string of the resource policy.

bucket str

Amazon Resource Name (ARN) of the bucket.

policy str

JSON string of the resource policy.

bucket String

Amazon Resource Name (ARN) of the bucket.

policy String

JSON string of the resource policy.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing BucketPolicy Resource

Get an existing BucketPolicy 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?: BucketPolicyState, opts?: CustomResourceOptions): BucketPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        policy: Optional[str] = None) -> BucketPolicy
func GetBucketPolicy(ctx *Context, name string, id IDInput, state *BucketPolicyState, opts ...ResourceOption) (*BucketPolicy, error)
public static BucketPolicy Get(string name, Input<string> id, BucketPolicyState? state, CustomResourceOptions? opts = null)
public static BucketPolicy get(String name, Output<String> id, BucketPolicyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
Bucket string

Amazon Resource Name (ARN) of the bucket.

Policy string

JSON string of the resource policy.

Bucket string

Amazon Resource Name (ARN) of the bucket.

Policy string

JSON string of the resource policy.

bucket String

Amazon Resource Name (ARN) of the bucket.

policy String

JSON string of the resource policy.

bucket string

Amazon Resource Name (ARN) of the bucket.

policy string

JSON string of the resource policy.

bucket str

Amazon Resource Name (ARN) of the bucket.

policy str

JSON string of the resource policy.

bucket String

Amazon Resource Name (ARN) of the bucket.

policy String

JSON string of the resource policy.

Import

S3 Control Bucket Policies can be imported using the Amazon Resource Name (ARN), e.g.,

 $ pulumi import aws:s3control/bucketPolicy:BucketPolicy example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/bucket/example

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.