MultiRegionAccessPointPolicy class
Provides a resource to manage an S3 Multi-Region Access Point access control policy.
Example Usage
Basic Example
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const current = aws.getCallerIdentity({});
const currentGetPartition = aws.getPartition({});
const fooBucket = new aws.s3.Bucket("foo_bucket", {bucket: "example-bucket-foo"});
const example = new aws.s3control.MultiRegionAccessPoint("example", {details: {
regions: [{
bucket: fooBucket.id,
}],
name: "example",
}});
const exampleMultiRegionAccessPointPolicy = new aws.s3control.MultiRegionAccessPointPolicy("example", {details: {
name: std.splitOutput({
separator: ":",
text: example.id,
}).result[1],
policy: pulumi.jsonStringify({
Version: "2012-10-17",
Statement: [{
Sid: "Example",
Effect: "Allow",
Principal: {
AWS: current.then(current => current.accountId),
},
Action: [
"s3:GetObject",
"s3:PutObject",
],
Resource: pulumi.all([currentGetPartition, current, example.alias]).apply(([currentGetPartition, current, alias]) => `arn:${currentGetPartition.partition}:s3::${current.accountId}:accesspoint/${alias}/object/*`),
}],
}),
}});
import pulumi
import json
import pulumi_aws as aws
import pulumi_std as std
current = aws.get_caller_identity()
current_get_partition = aws.get_partition()
foo_bucket = aws.s3.Bucket("foo_bucket", bucket="example-bucket-foo")
example = aws.s3control.MultiRegionAccessPoint("example", details={
"regions": [{
"bucket": foo_bucket.id,
}],
"name": "example",
})
example_multi_region_access_point_policy = aws.s3control.MultiRegionAccessPointPolicy("example", details={
"name": std.split_output(separator=":",
text=example.id).result[1],
"policy": pulumi.Output.json_dumps({
"Version": "2012-10-17",
"Statement": [{
"Sid": "Example",
"Effect": "Allow",
"Principal": {
"AWS": current.account_id,
},
"Action": [
"s3:GetObject",
"s3:PutObject",
],
"Resource": example.alias.apply(lambda alias: f"arn:{current_get_partition.partition}:s3::{current.account_id}:accesspoint/{alias}/object/*"),
}],
}),
})
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var current = Aws.GetCallerIdentity.Invoke();
var currentGetPartition = Aws.GetPartition.Invoke();
var fooBucket = new Aws.S3.Bucket("foo_bucket", new()
{
BucketName = "example-bucket-foo",
});
var example = new Aws.S3Control.MultiRegionAccessPoint("example", new()
{
Details = new Aws.S3Control.Inputs.MultiRegionAccessPointDetailsArgs
{
Regions = new[]
{
new Aws.S3Control.Inputs.MultiRegionAccessPointDetailsRegionArgs
{
Bucket = fooBucket.Id,
},
},
Name = "example",
},
});
var exampleMultiRegionAccessPointPolicy = new Aws.S3Control.MultiRegionAccessPointPolicy("example", new()
{
Details = new Aws.S3Control.Inputs.MultiRegionAccessPointPolicyDetailsArgs
{
Name = Std.Split.Invoke(new()
{
Separator = ":",
Text = example.Id,
}).Apply(invoke => invoke.Result)[1],
Policy = Output.JsonSerialize(Output.Create(new Dictionary<string, object?>
{
["Version"] = "2012-10-17",
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Sid"] = "Example",
["Effect"] = "Allow",
["Principal"] = new Dictionary<string, object?>
{
["AWS"] = current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
},
["Action"] = new[]
{
"s3:GetObject",
"s3:PutObject",
},
["Resource"] = Output.Tuple(currentGetPartition, current, example.Alias).Apply(values =>
{
var currentGetPartition = values.Item1;
var current = values.Item2;
var @alias = values.Item3;
return $"arn:{currentGetPartition.Apply(getPartitionResult => getPartitionResult.Partition)}:s3::{current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId)}:accesspoint/{@alias}/object/*";
}),
},
},
})),
},
});
});
package main
import (
"encoding/json"
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3control"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := aws.GetCallerIdentity(ctx, &aws.GetCallerIdentityArgs{}, nil)
if err != nil {
return err
}
currentGetPartition, err := aws.GetPartition(ctx, &aws.GetPartitionArgs{}, nil)
if err != nil {
return err
}
fooBucket, err := s3.NewBucket(ctx, "foo_bucket", &s3.BucketArgs{
Bucket: pulumi.String("example-bucket-foo"),
})
if err != nil {
return err
}
example, err := s3control.NewMultiRegionAccessPoint(ctx, "example", &s3control.MultiRegionAccessPointArgs{
Details: &s3control.MultiRegionAccessPointDetailsArgs{
Regions: s3control.MultiRegionAccessPointDetailsRegionArray{
&s3control.MultiRegionAccessPointDetailsRegionArgs{
Bucket: fooBucket.ID().ToIDOutput().ToStringOutput(),
},
},
Name: pulumi.String("example"),
},
})
if err != nil {
return err
}
_, err = s3control.NewMultiRegionAccessPointPolicy(ctx, "example", &s3control.MultiRegionAccessPointPolicyArgs{
Details: &s3control.MultiRegionAccessPointPolicyDetailsArgs{
Name: std.SplitOutput(ctx, std.SplitOutputArgs{
Separator: pulumi.String(":"),
Text: example.ID().ToIDOutput().ToStringOutput(),
}, nil).Result()[1],
Policy: example.Alias.ApplyT(func(alias string) (pulumi.String, error) {
var _zero pulumi.String
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Version": "2012-10-17",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Sid": "Example",
"Effect": "Allow",
"Principal": map[string]interface{}{
"AWS": current.AccountId,
},
"Action": []string{
"s3:GetObject",
"s3:PutObject",
},
"Resource": fmt.Sprintf("arn:%v:s3::%v:accesspoint/%v/object/*", currentGetPartition.Partition, current.AccountId, alias),
},
},
})
if err != nil {
return _zero, err
}
json0 := string(tmpJSON0)
return pulumi.String(json0), nil
}).(pulumi.StringOutput),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
std = {
source = "pulumi/std"
}
}
}
data "aws_getcalleridentity" "current" {
}
data "aws_getpartition" "currentGetPartition" {
}
resource "aws_s3_bucket" "foo_bucket" {
bucket = "example-bucket-foo"
}
resource "aws_s3control_multiregionaccesspoint" "example" {
details = {
regions = [{
"bucket" = aws_s3_bucket.foo_bucket.id
}]
name = "example"
}
}
resource "aws_s3control_multiregionaccesspointpolicy" "example" {
details = {
name = element(split(":", aws_s3control_multiregionaccesspoint.example.id), 1)
policy = jsonencode({
"Version" = "2012-10-17"
"Statement" = [{
"Sid" = "Example"
"Effect" = "Allow"
"Principal" = {
"AWS" = data.aws_getcalleridentity.current.account_id
}
"Action" = ["s3:GetObject", "s3:PutObject"]
"Resource" ="arn:${data.aws_getpartition.currentGetPartition.partition}:s3::${data.aws_getcalleridentity.current.account_id}:accesspoint/${aws_s3control_multiregionaccesspoint.example.alias}/object/*"
}]
})
}
}
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.GetCallerIdentityArgs;
import com.pulumi.aws.inputs.GetPartitionArgs;
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 com.pulumi.aws.s3control.MultiRegionAccessPointPolicy;
import com.pulumi.aws.s3control.MultiRegionAccessPointPolicyArgs;
import com.pulumi.aws.s3control.inputs.MultiRegionAccessPointPolicyDetailsArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.SplitArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
.build());
final var currentGetPartition = AwsFunctions.getPartition(GetPartitionArgs.builder()
.build());
var fooBucket = new Bucket("fooBucket", BucketArgs.builder()
.bucket("example-bucket-foo")
.build());
var example = new MultiRegionAccessPoint("example", MultiRegionAccessPointArgs.builder()
.details(MultiRegionAccessPointDetailsArgs.builder()
.regions(MultiRegionAccessPointDetailsRegionArgs.builder()
.bucket(fooBucket.id())
.build())
.name("example")
.build())
.build());
var exampleMultiRegionAccessPointPolicy = new MultiRegionAccessPointPolicy("exampleMultiRegionAccessPointPolicy", MultiRegionAccessPointPolicyArgs.builder()
.details(MultiRegionAccessPointPolicyDetailsArgs.builder()
.name(StdFunctions.split(SplitArgs.builder()
.separator(":")
.text(example.id())
.build()).applyValue(_invoke -> _invoke.result())[1])
.policy(example.alias().applyValue(_alias -> serializeJson(
jsonObject(
jsonProperty("Version", "2012-10-17"),
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Sid", "Example"),
jsonProperty("Effect", "Allow"),
jsonProperty("Principal", jsonObject(
jsonProperty("AWS", current.accountId())
)),
jsonProperty("Action", jsonArray(
"s3:GetObject",
"s3:PutObject"
)),
jsonProperty("Resource", String.format("arn:%s:s3::%s:accesspoint/%s/object/*", currentGetPartition.partition(),current.accountId(),_alias))
)))
))))
.build())
.build());
}
}
resources:
fooBucket:
type: aws:s3:Bucket
name: foo_bucket
properties:
bucket: example-bucket-foo
example:
type: aws:s3control:MultiRegionAccessPoint
properties:
details:
regions:
- bucket: ${fooBucket.id}
name: example
exampleMultiRegionAccessPointPolicy:
type: aws:s3control:MultiRegionAccessPointPolicy
name: example
properties:
details:
name:
fn::select:
- 1
- fn::invoke:
function: std:split
arguments:
separator: ':'
text: ${example.id}
return: result
policy:
fn::toJSON:
Version: 2012-10-17
Statement:
- Sid: Example
Effect: Allow
Principal:
AWS: ${current.accountId}
Action:
- s3:GetObject
- s3:PutObject
Resource: arn:${currentGetPartition.partition}:s3::${current.accountId}:accesspoint/${example.alias}/object/*
variables:
current:
fn::invoke:
function: aws:getCallerIdentity
arguments: {}
currentGetPartition:
fn::invoke:
function: aws:getPartition
arguments: {}
Import
Using pulumi import, import Multi-Region Access Point Policies using the accountId and name of the Multi-Region Access Point separated by a colon (:). For example:
$ pulumi import aws:s3control/multiRegionAccessPointPolicy:MultiRegionAccessPointPolicy example 123456789012:example
Constructors
- MultiRegionAccessPointPolicy(String name, {MultiRegionAccessPointPolicyArgs? args, CustomResourceOptions? options})
-
Creates a new MultiRegionAccessPointPolicy.
nameThe Pulumi resource name.argsArguments used to configure this MultiRegionAccessPointPolicy. The set of arguments for MultiRegionAccessPointPolicy.optionsResource options controlling this resource's behavior. - MultiRegionAccessPointPolicy.reference(String urn)
- Creates a typed reference to an existing MultiRegionAccessPointPolicy resource.
Properties
-
accountId
↔ Output<
String> -
AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
details
↔ Output<
MultiRegionAccessPointPolicyDetails> -
Configuration block containing details about the policy for the Multi-Region Access Point. See
detailsBlock below for more detailslatefinal -
established
↔ Output<
String> -
Last established policy for the Multi-Region Access Point.
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
-
proposed
↔ Output<
String> -
Proposed policy for 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
-
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, {MultiRegionAccessPointPolicyState? state, CustomResourceOptions? options}) → MultiRegionAccessPointPolicy -
Gets an existing MultiRegionAccessPointPolicy resource's state with the given
nameandid.