AccessPoint class
Provides a resource to manage an S3 Access Point.
> NOTE on Access Points and Access Point Policies: This provider provides both a standalone Access Point Policy resource and an Access Point resource with a resource policy defined in-line. You cannot use an Access Point with in-line resource policy in conjunction with an Access Point Policy resource. Doing so will cause a conflict of policies and will overwrite the access point's resource policy.
> Advanced usage: To use a custom API endpoint for this resource, use the s3control endpoint provider configuration), not the s3 endpoint provider configuration.
> This resource can be used with s3 directory buckets. Please see AWS Documentation for more information.
Example Usage
AWS Partition General Purpose Bucket
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.Bucket("example", {bucket: "example"});
const exampleAccessPoint = new aws.s3.AccessPoint("example", {
bucket: example.id,
name: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.s3.Bucket("example", bucket="example")
example_access_point = aws.s3.AccessPoint("example",
bucket=example.id,
name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3.Bucket("example", new()
{
BucketName = "example",
});
var exampleAccessPoint = new Aws.S3.AccessPoint("example", new()
{
Bucket = example.Id,
Name = "example",
});
});
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 {
example, err := s3.NewBucket(ctx, "example", &s3.BucketArgs{
Bucket: pulumi.String("example"),
})
if err != nil {
return err
}
_, err = s3.NewAccessPoint(ctx, "example", &s3.AccessPointArgs{
Bucket: example.ID().ToIDOutput().ToStringOutput(),
Name: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_bucket" "example" {
bucket = "example"
}
resource "aws_s3_accesspoint" "example" {
bucket = aws_s3_bucket.example.id
name = "example"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.Bucket;
import com.pulumi.aws.s3.BucketArgs;
import com.pulumi.aws.s3.AccessPoint;
import com.pulumi.aws.s3.AccessPointArgs;
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 Bucket("example", BucketArgs.builder()
.bucket("example")
.build());
var exampleAccessPoint = new AccessPoint("exampleAccessPoint", AccessPointArgs.builder()
.bucket(example.id())
.name("example")
.build());
}
}
resources:
example:
type: aws:s3:Bucket
properties:
bucket: example
exampleAccessPoint:
type: aws:s3:AccessPoint
name: example
properties:
bucket: ${example.id}
name: example
S3 on Outposts Bucket
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3control.Bucket("example", {bucket: "example"});
const exampleVpc = new aws.ec2.Vpc("example", {cidrBlock: "10.0.0.0/16"});
const exampleAccessPoint = new aws.s3.AccessPoint("example", {
vpcConfiguration: {
vpcId: exampleVpc.id,
},
bucket: example.arn,
name: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.s3control.Bucket("example", bucket="example")
example_vpc = aws.ec2.Vpc("example", cidr_block="10.0.0.0/16")
example_access_point = aws.s3.AccessPoint("example",
vpc_configuration={
"vpc_id": example_vpc.id,
},
bucket=example.arn,
name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3Control.Bucket("example", new()
{
BucketName = "example",
});
var exampleVpc = new Aws.Ec2.Vpc("example", new()
{
CidrBlock = "10.0.0.0/16",
});
var exampleAccessPoint = new Aws.S3.AccessPoint("example", new()
{
VpcConfiguration = new Aws.S3.Inputs.AccessPointVpcConfigurationArgs
{
VpcId = exampleVpc.Id,
},
Bucket = example.Arn,
Name = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"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 {
example, err := s3control.NewBucket(ctx, "example", &s3control.BucketArgs{
Bucket: pulumi.String("example"),
})
if err != nil {
return err
}
exampleVpc, err := ec2.NewVpc(ctx, "example", &ec2.VpcArgs{
CidrBlock: pulumi.String("10.0.0.0/16"),
})
if err != nil {
return err
}
_, err = s3.NewAccessPoint(ctx, "example", &s3.AccessPointArgs{
VpcConfiguration: &s3.AccessPointVpcConfigurationArgs{
VpcId: exampleVpc.ID().ToIDOutput().ToStringOutput(),
},
Bucket: example.Arn,
Name: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3control_bucket" "example" {
bucket = "example"
}
resource "aws_s3_accesspoint" "example" {
vpc_configuration = {
vpc_id = aws_ec2_vpc.example.id
}
bucket = aws_s3control_bucket.example.arn
name = "example"
}
resource "aws_ec2_vpc" "example" {
cidr_block = "10.0.0.0/16"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3control.Bucket;
import com.pulumi.aws.s3control.BucketArgs;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.s3.AccessPoint;
import com.pulumi.aws.s3.AccessPointArgs;
import com.pulumi.aws.s3.inputs.AccessPointVpcConfigurationArgs;
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 Bucket("example", BucketArgs.builder()
.bucket("example")
.build());
var exampleVpc = new Vpc("exampleVpc", VpcArgs.builder()
.cidrBlock("10.0.0.0/16")
.build());
var exampleAccessPoint = new AccessPoint("exampleAccessPoint", AccessPointArgs.builder()
.vpcConfiguration(AccessPointVpcConfigurationArgs.builder()
.vpcId(exampleVpc.id())
.build())
.bucket(example.arn())
.name("example")
.build());
}
}
resources:
example:
type: aws:s3control:Bucket
properties:
bucket: example
exampleAccessPoint:
type: aws:s3:AccessPoint
name: example
properties:
vpcConfiguration:
vpcId: ${exampleVpc.id}
bucket: ${example.arn}
name: example
exampleVpc:
type: aws:ec2:Vpc
name: example
properties:
cidrBlock: 10.0.0.0/16
AWS Partition Directory Bucket
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const available = aws.getAvailabilityZones({
state: "available",
});
const example = new aws.s3.DirectoryBucket("example", {
location: {
name: available.then(available => available.zoneIds?.[0]),
},
bucket: "example--zoneId--x-s3",
});
const exampleAccessPoint = new aws.s3.AccessPoint("example", {
bucket: test.bucket,
name: "example--zoneId--xa-s3",
});
import pulumi
import pulumi_aws as aws
available = aws.get_availability_zones(state="available")
example = aws.s3.DirectoryBucket("example",
location={
"name": available.zone_ids[0],
},
bucket="example--zoneId--x-s3")
example_access_point = aws.s3.AccessPoint("example",
bucket=test["bucket"],
name="example--zoneId--xa-s3")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var available = Aws.GetAvailabilityZones.Invoke(new()
{
State = "available",
});
var example = new Aws.S3.DirectoryBucket("example", new()
{
Location = new Aws.S3.Inputs.DirectoryBucketLocationArgs
{
Name = available.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.ZoneIds[0]),
},
Bucket = "example--zoneId--x-s3",
});
var exampleAccessPoint = new Aws.S3.AccessPoint("example", new()
{
Bucket = test.Bucket,
Name = "example--zoneId--xa-s3",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"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 {
available, err := aws.GetAvailabilityZones(ctx, &aws.GetAvailabilityZonesArgs{
State: pulumi.StringRef("available"),
}, nil)
if err != nil {
return err
}
_, err = s3.NewDirectoryBucket(ctx, "example", &s3.DirectoryBucketArgs{
Location: &s3.DirectoryBucketLocationArgs{
Name: pulumi.String(available.ZoneIds[0]),
},
Bucket: pulumi.String("example--zoneId--x-s3"),
})
if err != nil {
return err
}
_, err = s3.NewAccessPoint(ctx, "example", &s3.AccessPointArgs{
Bucket: pulumi.Any(test.Bucket),
Name: pulumi.String("example--zoneId--xa-s3"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_getavailabilityzones" "available" {
state = "available"
}
resource "aws_s3_directorybucket" "example" {
location = {
name = data.aws_getavailabilityzones.available.zone_ids[0]
}
bucket = "example--zoneId--x-s3"
}
resource "aws_s3_accesspoint" "example" {
bucket = test.bucket
name = "example--zoneId--xa-s3"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetAvailabilityZonesArgs;
import com.pulumi.aws.s3.DirectoryBucket;
import com.pulumi.aws.s3.DirectoryBucketArgs;
import com.pulumi.aws.s3.inputs.DirectoryBucketLocationArgs;
import com.pulumi.aws.s3.AccessPoint;
import com.pulumi.aws.s3.AccessPointArgs;
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) {
final var available = AwsFunctions.getAvailabilityZones(GetAvailabilityZonesArgs.builder()
.state("available")
.build());
var example = new DirectoryBucket("example", DirectoryBucketArgs.builder()
.location(DirectoryBucketLocationArgs.builder()
.name(available.zoneIds()[0])
.build())
.bucket("example--zoneId--x-s3")
.build());
var exampleAccessPoint = new AccessPoint("exampleAccessPoint", AccessPointArgs.builder()
.bucket(test.bucket())
.name("example--zoneId--xa-s3")
.build());
}
}
resources:
example:
type: aws:s3:DirectoryBucket
properties:
location:
name: ${available.zoneIds[0]}
bucket: example--zoneId--x-s3
exampleAccessPoint:
type: aws:s3:AccessPoint
name: example
properties:
bucket: ${test.bucket}
name: example--zoneId--xa-s3
variables:
available:
fn::invoke:
function: aws:getAvailabilityZones
arguments:
state: available
Import
Import using the ARN for Access Points associated with an S3 on Outposts Bucket:
Using pulumi import to import. For example:
Import using the accountId and name separated by a colon (:) for Access Points associated with an AWS Partition S3 Bucket:
$ pulumi import aws:s3/accessPoint:AccessPoint example 123456789012:example
Import using the ARN for Access Points associated with an S3 on Outposts Bucket:
$ pulumi import aws:s3/accessPoint:AccessPoint example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-1234567890123456/accesspoint/example
Constructors
- AccessPoint(String name, {AccessPointArgs? args, CustomResourceOptions? options})
-
Creates a new AccessPoint.
nameThe Pulumi resource name.argsArguments used to configure this AccessPoint. The set of arguments for AccessPoint.optionsResource options controlling this resource's behavior. - AccessPoint.reference(String urn)
- Creates a typed reference to an existing AccessPoint resource.
Properties
-
accountId
↔ Output<
String> -
AWS account ID for the owner of the bucket for which you want to create an access point. Defaults to automatically determined account ID of the AWS provider.
latefinal
-
alias
↔ Output<
String> -
Alias of the S3 Access Point.
latefinal
-
arn
↔ Output<
String> -
ARN of the S3 Access Point.
latefinal
-
bucket
↔ Output<
String> -
Name of an AWS Partition S3 General Purpose Bucket or the ARN of S3 on Outposts Bucket that you want to associate this access point with.
latefinal
-
bucketAccountId
↔ Output<
String> -
AWS account ID associated with the S3 bucket associated with this access point.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domainName
↔ Output<
String> -
DNS domain name of the S3 Access Point in the format
name-accountId.s3-accesspoint.region.amazonaws.com. S3 access points only support secure access by HTTPS. HTTP isn't supported.latefinal -
endpoints
↔ Output<
Map< String, String> > -
VPC endpoints for the S3 Access Point.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
hasPublicAccessPolicy
↔ Output<
bool> -
Whether this access point currently has a policy that allows public access.
latefinal
-
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
-
name
↔ Output<
String> -
Name you want to assign to this access point. See the AWS documentation for naming conditions.
latefinal
-
networkOrigin
↔ Output<
String> -
Whether this access point allows access from the public Internet. Values are
VPC(the access point doesn't allow access from the public Internet) andInternet(the access point allows access from the public Internet, subject to the access point and bucket access policies).latefinal -
policy
↔ Output<
String> -
Valid JSON document that specifies the policy that you want to apply to this access point. Removing
policyfrom your configuration or settingpolicyto null or an empty string (i.e.,policy = "") will not delete the policy since it could have been set byaws.s3control.AccessPointPolicy. To remove thepolicy, set it to"{}"(an empty JSON document).latefinal -
publicAccessBlockConfiguration
↔ Output<
AccessPointPublicAccessBlockConfiguration?> -
Configuration block to manage the
PublicAccessBlockconfiguration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. Detailed below.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
-
Map of tags to assign to the bucket. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcConfiguration
↔ Output<
AccessPointVpcConfiguration?> -
Configuration block to restrict access to this access point to requests from the specified VPC. Required for S3 on Outposts. Detailed below.
latefinal
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, {AccessPointState? state, CustomResourceOptions? options}) → AccessPoint -
Gets an existing AccessPoint resource's state with the given
nameandid.