AccountPublicAccessBlock class
Manages S3 account-level Public Access Block configuration. For more information about these settings, see the AWS S3 Block Public Access documentation.
> 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
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.AccountPublicAccessBlock("example", {
blockPublicAcls: true,
blockPublicPolicy: true,
});
import pulumi
import pulumi_aws as aws
example = aws.s3.AccountPublicAccessBlock("example",
block_public_acls=True,
block_public_policy=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3.AccountPublicAccessBlock("example", new()
{
BlockPublicAcls = true,
BlockPublicPolicy = true,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := s3.NewAccountPublicAccessBlock(ctx, "example", &s3.AccountPublicAccessBlockArgs{
BlockPublicAcls: pulumi.Bool(true),
BlockPublicPolicy: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_accountpublicaccessblock" "example" {
block_public_acls = true
block_public_policy = true
}
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());
}
}
resources:
example:
type: aws:s3:AccountPublicAccessBlock
properties:
blockPublicAcls: true
blockPublicPolicy: true
Import
Identity Schema
Required
accountId(String) AWS account ID.
Using pulumi import, import aws.s3.AccountPublicAccessBlock using the AWS account ID. For example:
$ pulumi import aws:s3/accountPublicAccessBlock:AccountPublicAccessBlock example 123456789012
Constructors
- AccountPublicAccessBlock(String name, {AccountPublicAccessBlockArgs? args, CustomResourceOptions? options})
-
Creates a new AccountPublicAccessBlock.
nameThe Pulumi resource name.argsArguments used to configure this AccountPublicAccessBlock. The set of arguments for AccountPublicAccessBlock.optionsResource options controlling this resource's behavior. - AccountPublicAccessBlock.reference(String urn)
- Creates a typed reference to an existing AccountPublicAccessBlock resource.
Properties
-
accountId
↔ Output<
String> -
AWS account ID to configure. Defaults to automatically determined account ID of the this provider AWS provider.
latefinal
-
blockPublicAcls
↔ Output<
bool?> -
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 totrue, 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.latefinal -
blockPublicPolicy
↔ Output<
bool?> -
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 totrue, Amazon S3 rejects calls to PUT Bucket policy if the specified bucket policy allows public access.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
-
ignorePublicAcls
↔ Output<
bool?> -
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 totrue, Amazon S3 ignores all public ACLs on buckets in this account and any objects that they contain.latefinal - 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
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
restrictPublicBuckets
↔ Output<
bool?> -
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 totrue, only the bucket owner and AWS Services can access buckets with public policies.latefinal - 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, {AccountPublicAccessBlockState? state, CustomResourceOptions? options}) → AccountPublicAccessBlock -
Gets an existing AccountPublicAccessBlock resource's state with the given
nameandid.