Package com.pulumi.aws.s3

Class AccountPublicAccessBlock

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.s3.AccountPublicAccessBlock

public class AccountPublicAccessBlock
extends com.pulumi.resources.CustomResource

Manages S3 account-level Public Access Block configuration. For more information about these settings, see the [AWS S3 Block Public Access documentation](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html). > **NOTE:** Each AWS account may only have one S3 Public Access Block configuration. Multiple configurations of the resource against the same AWS account will cause a perpetual difference. > Advanced usage: To use a custom API endpoint for this resource, use the `s3control` endpoint provider configuration, not the `s3` endpoint provider configuration. ## Example Usage

 
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.s3.AccountPublicAccessBlock;
 import com.pulumi.aws.s3.AccountPublicAccessBlockArgs;
 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 AccountPublicAccessBlock("example", AccountPublicAccessBlockArgs.builder()
             .blockPublicAcls(true)
             .blockPublicPolicy(true)
             .build());
 
     }
 }
 
 

## Import ### Identity Schema #### Required * `accountId` (String) AWS account ID. Using `pulumi import`, import `aws.s3.AccountPublicAccessBlock` using the AWS account ID. For example: ```sh $ pulumi import aws:s3/accountPublicAccessBlock:AccountPublicAccessBlock example 123456789012 ```

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

Constructor Summary

Constructors

Constructor	Description
AccountPublicAccessBlock(java.lang.String name)
AccountPublicAccessBlock(java.lang.String name, AccountPublicAccessBlockArgs args)
AccountPublicAccessBlock(java.lang.String name, AccountPublicAccessBlockArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	accountId()
com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>>	blockPublicAcls()
com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>>	blockPublicPolicy()
static AccountPublicAccessBlock	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AccountPublicAccessBlockState 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.util.Optional<java.lang.Boolean>>	ignorePublicAcls()
com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>>	restrictPublicBuckets()

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

AccountPublicAccessBlock

public AccountPublicAccessBlock(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

AccountPublicAccessBlock

public AccountPublicAccessBlock(java.lang.String name,
                                @Nullable
                                AccountPublicAccessBlockArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

AccountPublicAccessBlock

public AccountPublicAccessBlock(java.lang.String name,
                                @Nullable
                                AccountPublicAccessBlockArgs 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

accountId

public com.pulumi.core.Output<java.lang.String> accountId()

Returns:

AWS account ID to configure. Defaults to automatically determined account ID of the this provider AWS provider.

blockPublicAcls

public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blockPublicAcls()

Returns:

Whether Amazon S3 should block public ACLs for buckets in this account. Defaults to `false`. Enabling this setting does not affect existing policies or ACLs. When set to `true`, PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL allows public access, and PUT Object calls fail if the request includes a public ACL.

blockPublicPolicy

public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blockPublicPolicy()

Returns:

Whether Amazon S3 should block public bucket policies for buckets in this account. Defaults to `false`. Enabling this setting does not affect existing bucket policies. When set to `true`, Amazon S3 rejects calls to PUT Bucket policy if the specified bucket policy allows public access.

ignorePublicAcls

public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> ignorePublicAcls()

Returns:

Whether Amazon S3 should ignore public ACLs for buckets in this account. 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`, Amazon S3 ignores all public ACLs on buckets in this account and any objects that they contain.

restrictPublicBuckets

public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> restrictPublicBuckets()

Returns:

Whether Amazon S3 should restrict public bucket policies for buckets in this account. Defaults to `false`. Enabling this setting does not affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. When set to `true`, only the bucket owner and AWS Services can access buckets with public policies.

get

public static AccountPublicAccessBlock get(java.lang.String name,
                                           com.pulumi.core.Output<java.lang.String> id,
                                           @Nullable
                                           AccountPublicAccessBlockState 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.