Package com.pulumi.aws.s3control

Class BucketPolicy

  • public class BucketPolicy
extends com.pulumi.resources.CustomResource
    Provides a resource to manage an S3 Control Bucket Policy. > This functionality is for managing [S3 on Outposts](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html). To manage S3 Bucket Policies in an AWS Partition, see the `aws.s3.BucketPolicy` resource. ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import S3 Control Bucket Policies using the ARN. For example: ```sh $ pulumi import aws:s3control/bucketPolicy:BucketPolicy example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/bucket/example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> bucket()  
      static BucketPolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, BucketPolicyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> policy()  
      com.pulumi.core.Output<java.lang.String> region()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BucketPolicy

        public BucketPolicy​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • BucketPolicy

        public BucketPolicy​(java.lang.String name,
                    BucketPolicyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • BucketPolicy

        public BucketPolicy​(java.lang.String name,
                    BucketPolicyArgs args,
                    @Nullable
                    com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • bucket

        public com.pulumi.core.Output<java.lang.String> bucket()
        Returns:
        ARN of the bucket.

      • policy

        public com.pulumi.core.Output<java.lang.String> policy()
        Returns:
        JSON string of the resource policy.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • get

        public static BucketPolicy get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               BucketPolicyState state,
                               @Nullable
                               com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.