Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. s3control
  5. BucketPolicy
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.s3control.BucketPolicy

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

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

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

const example = new aws.s3control.BucketPolicy("example", {
    bucket: exampleAwsS3controlBucket.arn,
    policy: JSON.stringify({
        Id: "testBucketPolicy",
        Statement: [{
            Action: "s3-outposts:PutBucketLifecycleConfiguration",
            Effect: "Deny",
            Principal: {
                AWS: "*",
            },
            Resource: exampleAwsS3controlBucket.arn,
            Sid: "statement1",
        }],
        Version: "2012-10-17",
    }),
});
Copy
import pulumi
import json
import pulumi_aws as aws

example = aws.s3control.BucketPolicy("example",
    bucket=example_aws_s3control_bucket["arn"],
    policy=json.dumps({
        "Id": "testBucketPolicy",
        "Statement": [{
            "Action": "s3-outposts:PutBucketLifecycleConfiguration",
            "Effect": "Deny",
            "Principal": {
                "AWS": "*",
            },
            "Resource": example_aws_s3control_bucket["arn"],
            "Sid": "statement1",
        }],
        "Version": "2012-10-17",
    }))
Copy
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v6/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": exampleAwsS3controlBucket.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(exampleAwsS3controlBucket.Arn),
			Policy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.S3Control.BucketPolicy("example", new()
    {
        Bucket = exampleAwsS3controlBucket.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"] = exampleAwsS3controlBucket.Arn,
                    ["Sid"] = "statement1",
                },
            },
            ["Version"] = "2012-10-17",
        }),
    });

});
Copy
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(exampleAwsS3controlBucket.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", exampleAwsS3controlBucket.arn()),
                        jsonProperty("Sid", "statement1")
                    ))),
                    jsonProperty("Version", "2012-10-17")
                )))
            .build());

    }
}
Copy
resources:
  example:
    type: aws:s3control:BucketPolicy
    properties:
      bucket: ${exampleAwsS3controlBucket.arn}
      policy:
        fn::toJSON:
          Id: testBucketPolicy
          Statement:
            - Action: s3-outposts:PutBucketLifecycleConfiguration
              Effect: Deny
              Principal:
                AWS: '*'
              Resource: ${exampleAwsS3controlBucket.arn}
              Sid: statement1
          Version: 2012-10-17
Copy

Create BucketPolicy Resource

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

Constructor syntax

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

@overload
def BucketPolicy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 bucket: Optional[str] = None,
                 policy: Optional[str] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BucketPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. BucketPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BucketPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BucketPolicyArgs
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 awsBucketPolicyResource = new Aws.S3Control.BucketPolicy("awsBucketPolicyResource", new()
{
    Bucket = "string",
    Policy = "string",
});
Copy
example, err := s3control.NewBucketPolicy(ctx, "awsBucketPolicyResource", &s3control.BucketPolicyArgs{
	Bucket: pulumi.String("string"),
	Policy: pulumi.String("string"),
})
Copy
var awsBucketPolicyResource = new BucketPolicy("awsBucketPolicyResource", BucketPolicyArgs.builder()
    .bucket("string")
    .policy("string")
    .build());
Copy
aws_bucket_policy_resource = aws.s3control.BucketPolicy("awsBucketPolicyResource",
    bucket="string",
    policy="string")
Copy
const awsBucketPolicyResource = new aws.s3control.BucketPolicy("awsBucketPolicyResource", {
    bucket: "string",
    policy: "string",
});
Copy
type: aws:s3control:BucketPolicy
properties:
    bucket: string
    policy: string
Copy

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

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

The BucketPolicy resource accepts the following input properties:

Bucket
This property is required.
Changes to this property will trigger replacement.
string
Amazon Resource Name (ARN) of the bucket.
Policy This property is required. string
JSON string of the resource policy.
Bucket
This property is required.
Changes to this property will trigger replacement.
string
Amazon Resource Name (ARN) of the bucket.
Policy This property is required. string
JSON string of the resource policy.
bucket
This property is required.
Changes to this property will trigger replacement.
String
Amazon Resource Name (ARN) of the bucket.
policy This property is required. String
JSON string of the resource policy.
bucket
This property is required.
Changes to this property will trigger replacement.
string
Amazon Resource Name (ARN) of the bucket.
policy This property is required. string
JSON string of the resource policy.
bucket
This property is required.
Changes to this property will trigger replacement.
str
Amazon Resource Name (ARN) of the bucket.
policy This property is required. str
JSON string of the resource policy.
bucket
This property is required.
Changes to this property will trigger replacement.
String
Amazon Resource Name (ARN) of the bucket.
policy This property is required. 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 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)
resources:  _:    type: aws:s3control:BucketPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
Amazon Resource Name (ARN) of the bucket.
Policy string
JSON string of the resource policy.
Bucket Changes to this property will trigger replacement. string
Amazon Resource Name (ARN) of the bucket.
Policy string
JSON string of the resource policy.
bucket Changes to this property will trigger replacement. String
Amazon Resource Name (ARN) of the bucket.
policy String
JSON string of the resource policy.
bucket Changes to this property will trigger replacement. string
Amazon Resource Name (ARN) of the bucket.
policy string
JSON string of the resource policy.
bucket Changes to this property will trigger replacement. str
Amazon Resource Name (ARN) of the bucket.
policy str
JSON string of the resource policy.
bucket Changes to this property will trigger replacement. String
Amazon Resource Name (ARN) of the bucket.
policy String
JSON string of the resource policy.

Import

Using pulumi import, import S3 Control Bucket Policies using the Amazon Resource Name (ARN). For example:

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

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 v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws