BucketPolicyS3Control class
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",
}),
});
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",
}))
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",
}),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/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]string{
"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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3control_bucketpolicy" "example" {
bucket = exampleAwsS3controlBucket.arn
policy = jsonencode({
"Id" = "testBucketPolicy"
"Statement" = [{
"Action" = "s3-outposts:PutBucketLifecycleConfiguration"
"Effect" = "Deny"
"Principal" = {
"AWS" = "*"
}
"Resource" = exampleAwsS3controlBucket.arn
"Sid" = "statement1"
}]
"Version" = "2012-10-17"
})
}
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.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 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());
}
}
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
Import
Using pulumi import, import S3 Control Bucket Policies using the ARN. For example:
$ pulumi import aws:s3control/bucketPolicy:BucketPolicy example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/bucket/example
Constructors
- BucketPolicyS3Control(String name, {BucketPolicyS3ControlArgs? args, CustomResourceOptions? options})
-
Creates a new BucketPolicyS3Control.
nameThe Pulumi resource name.argsArguments used to configure this BucketPolicyS3Control. The set of arguments for BucketPolicy.optionsResource options controlling this resource's behavior. - BucketPolicyS3Control.reference(String urn)
- Creates a typed reference to an existing BucketPolicyS3Control resource.
Properties
-
bucket
↔ Output<
String> -
ARN of the bucket.
latefinal
-
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
-
policy
↔ Output<
String> -
JSON string of the resource policy.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
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, {BucketPolicyS3ControlState? state, CustomResourceOptions? options}) → BucketPolicyS3Control -
Gets an existing BucketPolicyS3Control resource's state with the given
nameandid.