MultiRegionAccessPoint class
Provides a resource to manage an S3 Multi-Region Access Point associated with specified buckets.
> This resource cannot be used with S3 directory buckets.
For more information, see the documentation on Multi-Region Access Points.
Example Usage
Multiple AWS Buckets in Different Regions
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const fooBucket = new aws.s3.Bucket("foo_bucket", {bucket: "example-bucket-foo"});
const barBucket = new aws.s3.Bucket("bar_bucket", {bucket: "example-bucket-bar"});
const example = new aws.s3control.MultiRegionAccessPoint("example", {details: {
regions: [
{
bucket: fooBucket.id,
},
{
bucket: barBucket.id,
},
],
name: "example",
}});
import pulumi
import pulumi_aws as aws
foo_bucket = aws.s3.Bucket("foo_bucket", bucket="example-bucket-foo")
bar_bucket = aws.s3.Bucket("bar_bucket", bucket="example-bucket-bar")
example = aws.s3control.MultiRegionAccessPoint("example", details={
"regions": [
{
"bucket": foo_bucket.id,
},
{
"bucket": bar_bucket.id,
},
],
"name": "example",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var fooBucket = new Aws.S3.Bucket("foo_bucket", new()
{
BucketName = "example-bucket-foo",
});
var barBucket = new Aws.S3.Bucket("bar_bucket", new()
{
BucketName = "example-bucket-bar",
});
var example = new Aws.S3Control.MultiRegionAccessPoint("example", new()
{
Details = new Aws.S3Control.Inputs.MultiRegionAccessPointDetailsArgs
{
Regions = new[]
{
new Aws.S3Control.Inputs.MultiRegionAccessPointDetailsRegionArgs
{
Bucket = fooBucket.Id,
},
new Aws.S3Control.Inputs.MultiRegionAccessPointDetailsRegionArgs
{
Bucket = barBucket.Id,
},
},
Name = "example",
},
});
});
package main
import (
"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 {
fooBucket, err := s3.NewBucket(ctx, "foo_bucket", &s3.BucketArgs{
Bucket: pulumi.String("example-bucket-foo"),
})
if err != nil {
return err
}
barBucket, err := s3.NewBucket(ctx, "bar_bucket", &s3.BucketArgs{
Bucket: pulumi.String("example-bucket-bar"),
})
if err != nil {
return err
}
_, err = s3control.NewMultiRegionAccessPoint(ctx, "example", &s3control.MultiRegionAccessPointArgs{
Details: &s3control.MultiRegionAccessPointDetailsArgs{
Regions: s3control.MultiRegionAccessPointDetailsRegionArray{
&s3control.MultiRegionAccessPointDetailsRegionArgs{
Bucket: fooBucket.ID().ToIDOutput().ToStringOutput(),
},
&s3control.MultiRegionAccessPointDetailsRegionArgs{
Bucket: barBucket.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" "foo_bucket" {
bucket = "example-bucket-foo"
}
resource "aws_s3_bucket" "bar_bucket" {
bucket = "example-bucket-bar"
}
resource "aws_s3control_multiregionaccesspoint" "example" {
details = {
regions = [{
"bucket" = aws_s3_bucket.foo_bucket.id
}, {
"bucket" = aws_s3_bucket.bar_bucket.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.s3control.MultiRegionAccessPoint;
import com.pulumi.aws.s3control.MultiRegionAccessPointArgs;
import com.pulumi.aws.s3control.inputs.MultiRegionAccessPointDetailsArgs;
import com.pulumi.aws.s3control.inputs.MultiRegionAccessPointDetailsRegionArgs;
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 fooBucket = new Bucket("fooBucket", BucketArgs.builder()
.bucket("example-bucket-foo")
.build());
var barBucket = new Bucket("barBucket", BucketArgs.builder()
.bucket("example-bucket-bar")
.build());
var example = new MultiRegionAccessPoint("example", MultiRegionAccessPointArgs.builder()
.details(MultiRegionAccessPointDetailsArgs.builder()
.regions(
MultiRegionAccessPointDetailsRegionArgs.builder()
.bucket(fooBucket.id())
.build(),
MultiRegionAccessPointDetailsRegionArgs.builder()
.bucket(barBucket.id())
.build())
.name("example")
.build())
.build());
}
}
resources:
fooBucket:
type: aws:s3:Bucket
name: foo_bucket
properties:
bucket: example-bucket-foo
barBucket:
type: aws:s3:Bucket
name: bar_bucket
properties:
bucket: example-bucket-bar
example:
type: aws:s3control:MultiRegionAccessPoint
properties:
details:
regions:
- bucket: ${fooBucket.id}
- bucket: ${barBucket.id}
name: example
Import
Identity Schema
Required
name(String) Name of the Multi-Region Access Point.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import Multi-Region Access Points using the accountId and name of the Multi-Region Access Point separated by a colon (:). For example:
$ pulumi import aws:s3control/multiRegionAccessPoint:MultiRegionAccessPoint example 123456789012:example
Constructors
- MultiRegionAccessPoint(String name, {MultiRegionAccessPointArgs? args, CustomResourceOptions? options})
-
Creates a new MultiRegionAccessPoint.
nameThe Pulumi resource name.argsArguments used to configure this MultiRegionAccessPoint. The set of arguments for MultiRegionAccessPoint.optionsResource options controlling this resource's behavior. - MultiRegionAccessPoint.reference(String urn)
- Creates a typed reference to an existing MultiRegionAccessPoint resource.
Properties
-
accountId
↔ Output<
String> -
AWS account ID for the owner of the buckets for which you want to create a Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
latefinal
-
alias
↔ Output<
String> -
Alias for the Multi-Region Access Point.
latefinal
-
arn
↔ Output<
String> -
ARN of the Multi-Region Access Point.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
details
↔ Output<
MultiRegionAccessPointDetails> -
Configuration block containing details about the Multi-Region Access Point. See
detailsBlock below.latefinal -
domainName
↔ Output<
String> -
DNS domain name of the S3 Multi-Region Access Point in the format
alias.accesspoint.s3-global.amazonaws.com. For more information, see the documentation on Multi-Region Access Point Requests.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
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 of the Multi-Region Access Point.
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
-
status
↔ Output<
String> -
Status of the Multi-Region Access Point. One of:
READY,INCONSISTENT_ACROSS_REGIONS,CREATING,PARTIALLY_CREATED,PARTIALLY_DELETED,DELETING.latefinal -
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, {MultiRegionAccessPointState? state, CustomResourceOptions? options}) → MultiRegionAccessPoint -
Gets an existing MultiRegionAccessPoint resource's state with the given
nameandid.