pulumi-aws-kotlin/com.pulumi.aws.s3.kotlin/BucketPublicAccessBlock

BucketPublicAccessBlock

class BucketPublicAccessBlock : KotlinCustomResource

Manages S3 bucket-level Public Access Block configuration. For more information about these settings, see the AWS S3 Block Public Access documentation.

This resource cannot be used with S3 directory buckets.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketV2;
import com.pulumi.aws.s3.BucketPublicAccessBlock;
import com.pulumi.aws.s3.BucketPublicAccessBlockArgs;
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 exampleBucketV2 = new BucketV2("exampleBucketV2");
        var exampleBucketPublicAccessBlock = new BucketPublicAccessBlock("exampleBucketPublicAccessBlock", BucketPublicAccessBlockArgs.builder()
            .bucket(exampleBucketV2.id())
            .blockPublicAcls(true)
            .blockPublicPolicy(true)
            .ignorePublicAcls(true)
            .restrictPublicBuckets(true)
            .build());
    }
}

Import

Using pulumi import, import aws_s3_bucket_public_access_block using the bucket name. For example:

$ pulumi import aws:s3/bucketPublicAccessBlock:BucketPublicAccessBlock example my-bucket

Properties

blockPublicAcls

val blockPublicAcls: Output<Boolean>?

Whether Amazon S3 should block public ACLs for this bucket. Defaults to false. Enabling this setting does not affect existing policies or ACLs. When set to true causes the following behavior:

blockPublicPolicy

val blockPublicPolicy: Output<Boolean>?

Whether Amazon S3 should block public bucket policies for this bucket. Defaults to false. Enabling this setting does not affect the existing bucket policy. When set to true causes Amazon S3 to:

bucket

val bucket: Output<String>

S3 Bucket to which this Public Access Block configuration should be applied.

val id: Output<String>

ignorePublicAcls

val ignorePublicAcls: Output<Boolean>?

Whether Amazon S3 should ignore public ACLs for this bucket. Defaults to false. Enabling this setting does not affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. When set to true causes Amazon S3 to:

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

restrictPublicBuckets

val restrictPublicBuckets: Output<Boolean>?

Whether Amazon S3 should restrict public bucket policies for this bucket. Defaults to false. Enabling this setting does not affect the previously stored bucket policy, except that public and cross-account access within the public bucket policy, including non-public delegation to specific accounts, is blocked. When set to true:

urn

val urn: Output<String>