MultiRegionAccessPointRoutes class

Provides a resource to manage the routing configuration for an S3 Multi-Region Access Point.

> Note: Destruction of this resource only removes it from state. It does not alter the configured traffic routing percentages.

Example Usage

Active-Active Configuration

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const primary = new aws.s3.Bucket("primary", {bucket: "example-bucket-primary"});
const secondary = new aws.s3.Bucket("secondary", {bucket: "example-bucket-secondary"});
const example = new aws.s3control.MultiRegionAccessPoint("example", {details: {
    regions: [
        {
            bucket: primary.bucket,
        },
        {
            bucket: secondary.bucket,
        },
    ],
    name: "example",
}});
const exampleMultiRegionAccessPointRoutes = new aws.s3control.MultiRegionAccessPointRoutes("example", {
    routes: [
        {
            bucket: primary.bucket,
            region: primary.bucketRegion,
            trafficDialPercentage: 100,
        },
        {
            bucket: secondary.bucket,
            region: secondary.bucketRegion,
            trafficDialPercentage: 100,
        },
    ],
    mrap: example.arn,
});
import pulumi
import pulumi_aws as aws

primary = aws.s3.Bucket("primary", bucket="example-bucket-primary")
secondary = aws.s3.Bucket("secondary", bucket="example-bucket-secondary")
example = aws.s3control.MultiRegionAccessPoint("example", details={
    "regions": [
        {
            "bucket": primary.bucket,
        },
        {
            "bucket": secondary.bucket,
        },
    ],
    "name": "example",
})
example_multi_region_access_point_routes = aws.s3control.MultiRegionAccessPointRoutes("example",
    routes=[
        {
            "bucket": primary.bucket,
            "region": primary.bucket_region,
            "traffic_dial_percentage": 100,
        },
        {
            "bucket": secondary.bucket,
            "region": secondary.bucket_region,
            "traffic_dial_percentage": 100,
        },
    ],
    mrap=example.arn)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var primary = new Aws.S3.Bucket("primary", new()
    {
        BucketName = "example-bucket-primary",
    });

    var secondary = new Aws.S3.Bucket("secondary", new()
    {
        BucketName = "example-bucket-secondary",
    });

    var example = new Aws.S3Control.MultiRegionAccessPoint("example", new()
    {
        Details = new Aws.S3Control.Inputs.MultiRegionAccessPointDetailsArgs
        {
            Regions = new[]
            {
                new Aws.S3Control.Inputs.MultiRegionAccessPointDetailsRegionArgs
                {
                    Bucket = primary.BucketName,
                },
                new Aws.S3Control.Inputs.MultiRegionAccessPointDetailsRegionArgs
                {
                    Bucket = secondary.BucketName,
                },
            },
            Name = "example",
        },
    });

    var exampleMultiRegionAccessPointRoutes = new Aws.S3Control.MultiRegionAccessPointRoutes("example", new()
    {
        Routes = new[]
        {
            new Aws.S3Control.Inputs.MultiRegionAccessPointRoutesRouteArgs
            {
                Bucket = primary.BucketName,
                Region = primary.BucketRegion,
                TrafficDialPercentage = 100,
            },
            new Aws.S3Control.Inputs.MultiRegionAccessPointRoutesRouteArgs
            {
                Bucket = secondary.BucketName,
                Region = secondary.BucketRegion,
                TrafficDialPercentage = 100,
            },
        },
        Mrap = example.Arn,
    });

});
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 {
		primary, err := s3.NewBucket(ctx, "primary", &s3.BucketArgs{
			Bucket: pulumi.String("example-bucket-primary"),
		})
		if err != nil {
			return err
		}
		secondary, err := s3.NewBucket(ctx, "secondary", &s3.BucketArgs{
			Bucket: pulumi.String("example-bucket-secondary"),
		})
		if err != nil {
			return err
		}
		example, err := s3control.NewMultiRegionAccessPoint(ctx, "example", &s3control.MultiRegionAccessPointArgs{
			Details: &s3control.MultiRegionAccessPointDetailsArgs{
				Regions: s3control.MultiRegionAccessPointDetailsRegionArray{
					&s3control.MultiRegionAccessPointDetailsRegionArgs{
						Bucket: primary.Bucket,
					},
					&s3control.MultiRegionAccessPointDetailsRegionArgs{
						Bucket: secondary.Bucket,
					},
				},
				Name: pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		_, err = s3control.NewMultiRegionAccessPointRoutes(ctx, "example", &s3control.MultiRegionAccessPointRoutesArgs{
			Routes: s3control.MultiRegionAccessPointRoutesRouteArray{
				&s3control.MultiRegionAccessPointRoutesRouteArgs{
					Bucket:                primary.Bucket,
					Region:                primary.BucketRegion,
					TrafficDialPercentage: pulumi.Int(100),
				},
				&s3control.MultiRegionAccessPointRoutesRouteArgs{
					Bucket:                secondary.Bucket,
					Region:                secondary.BucketRegion,
					TrafficDialPercentage: pulumi.Int(100),
				},
			},
			Mrap: example.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_bucket" "primary" {
  bucket = "example-bucket-primary"
}
resource "aws_s3_bucket" "secondary" {
  bucket = "example-bucket-secondary"
}
resource "aws_s3control_multiregionaccesspoint" "example" {
  details = {
    regions = [{
      "bucket" = aws_s3_bucket.primary.bucket
      }, {
      "bucket" = aws_s3_bucket.secondary.bucket
    }]
    name = "example"
  }
}
resource "aws_s3control_multiregionaccesspointroutes" "example" {
  routes {
    bucket                  = aws_s3_bucket.primary.bucket
    region                  = aws_s3_bucket.primary.bucket_region
    traffic_dial_percentage = 100
  }
  routes {
    bucket                  = aws_s3_bucket.secondary.bucket
    region                  = aws_s3_bucket.secondary.bucket_region
    traffic_dial_percentage = 100
  }
  mrap = aws_s3control_multiregionaccesspoint.example.arn
}
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 com.pulumi.aws.s3control.MultiRegionAccessPointRoutes;
import com.pulumi.aws.s3control.MultiRegionAccessPointRoutesArgs;
import com.pulumi.aws.s3control.inputs.MultiRegionAccessPointRoutesRouteArgs;
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 primary = new Bucket("primary", BucketArgs.builder()
            .bucket("example-bucket-primary")
            .build());

        var secondary = new Bucket("secondary", BucketArgs.builder()
            .bucket("example-bucket-secondary")
            .build());

        var example = new MultiRegionAccessPoint("example", MultiRegionAccessPointArgs.builder()
            .details(MultiRegionAccessPointDetailsArgs.builder()
                .regions(
                    MultiRegionAccessPointDetailsRegionArgs.builder()
                        .bucket(primary.bucket())
                        .build(),
                    MultiRegionAccessPointDetailsRegionArgs.builder()
                        .bucket(secondary.bucket())
                        .build())
                .name("example")
                .build())
            .build());

        var exampleMultiRegionAccessPointRoutes = new MultiRegionAccessPointRoutes("exampleMultiRegionAccessPointRoutes", MultiRegionAccessPointRoutesArgs.builder()
            .routes(
                MultiRegionAccessPointRoutesRouteArgs.builder()
                    .bucket(primary.bucket())
                    .region(primary.bucketRegion())
                    .trafficDialPercentage(100)
                    .build(),
                MultiRegionAccessPointRoutesRouteArgs.builder()
                    .bucket(secondary.bucket())
                    .region(secondary.bucketRegion())
                    .trafficDialPercentage(100)
                    .build())
            .mrap(example.arn())
            .build());

    }
}
resources:
  primary:
    type: aws:s3:Bucket
    properties:
      bucket: example-bucket-primary
  secondary:
    type: aws:s3:Bucket
    properties:
      bucket: example-bucket-secondary
  example:
    type: aws:s3control:MultiRegionAccessPoint
    properties:
      details:
        regions:
          - bucket: ${primary.bucket}
          - bucket: ${secondary.bucket}
        name: example
  exampleMultiRegionAccessPointRoutes:
    type: aws:s3control:MultiRegionAccessPointRoutes
    name: example
    properties:
      routes:
        - bucket: ${primary.bucket}
          region: ${primary.bucketRegion}
          trafficDialPercentage: 100
        - bucket: ${secondary.bucket}
          region: ${secondary.bucketRegion}
          trafficDialPercentage: 100
      mrap: ${example.arn}

Failover Configuration

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3control.MultiRegionAccessPointRoutes("example", {
    routes: [
        {
            bucket: primary.bucket,
            region: primary.bucketRegion,
            trafficDialPercentage: 0,
        },
        {
            bucket: secondary.bucket,
            region: secondary.bucketRegion,
            trafficDialPercentage: 100,
        },
    ],
    mrap: exampleAwsS3controlMultiRegionAccessPoint.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.s3control.MultiRegionAccessPointRoutes("example",
    routes=[
        {
            "bucket": primary["bucket"],
            "region": primary["bucketRegion"],
            "traffic_dial_percentage": 0,
        },
        {
            "bucket": secondary["bucket"],
            "region": secondary["bucketRegion"],
            "traffic_dial_percentage": 100,
        },
    ],
    mrap=example_aws_s3control_multi_region_access_point["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.S3Control.MultiRegionAccessPointRoutes("example", new()
    {
        Routes = new[]
        {
            new Aws.S3Control.Inputs.MultiRegionAccessPointRoutesRouteArgs
            {
                Bucket = primary.Bucket,
                Region = primary.BucketRegion,
                TrafficDialPercentage = 0,
            },
            new Aws.S3Control.Inputs.MultiRegionAccessPointRoutesRouteArgs
            {
                Bucket = secondary.Bucket,
                Region = secondary.BucketRegion,
                TrafficDialPercentage = 100,
            },
        },
        Mrap = exampleAwsS3controlMultiRegionAccessPoint.Arn,
    });

});
package main

import (
	"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 {
		_, err := s3control.NewMultiRegionAccessPointRoutes(ctx, "example", &s3control.MultiRegionAccessPointRoutesArgs{
			Routes: s3control.MultiRegionAccessPointRoutesRouteArray{
				&s3control.MultiRegionAccessPointRoutesRouteArgs{
					Bucket:                pulumi.Any(primary.Bucket),
					Region:                pulumi.Any(primary.BucketRegion),
					TrafficDialPercentage: pulumi.Int(0),
				},
				&s3control.MultiRegionAccessPointRoutesRouteArgs{
					Bucket:                pulumi.Any(secondary.Bucket),
					Region:                pulumi.Any(secondary.BucketRegion),
					TrafficDialPercentage: pulumi.Int(100),
				},
			},
			Mrap: pulumi.Any(exampleAwsS3controlMultiRegionAccessPoint.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3control_multiregionaccesspointroutes" "example" {
  routes {
    bucket                  = primary.bucket
    region                  = primary.bucketRegion
    traffic_dial_percentage = 0
  }
  routes {
    bucket                  = secondary.bucket
    region                  = secondary.bucketRegion
    traffic_dial_percentage = 100
  }
  mrap = exampleAwsS3controlMultiRegionAccessPoint.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3control.MultiRegionAccessPointRoutes;
import com.pulumi.aws.s3control.MultiRegionAccessPointRoutesArgs;
import com.pulumi.aws.s3control.inputs.MultiRegionAccessPointRoutesRouteArgs;
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 MultiRegionAccessPointRoutes("example", MultiRegionAccessPointRoutesArgs.builder()
            .routes(
                MultiRegionAccessPointRoutesRouteArgs.builder()
                    .bucket(primary.bucket())
                    .region(primary.bucketRegion())
                    .trafficDialPercentage(0)
                    .build(),
                MultiRegionAccessPointRoutesRouteArgs.builder()
                    .bucket(secondary.bucket())
                    .region(secondary.bucketRegion())
                    .trafficDialPercentage(100)
                    .build())
            .mrap(exampleAwsS3controlMultiRegionAccessPoint.arn())
            .build());

    }
}
resources:
  example:
    type: aws:s3control:MultiRegionAccessPointRoutes
    properties:
      routes:
        - bucket: ${primary.bucket}
          region: ${primary.bucketRegion}
          trafficDialPercentage: 0
        - bucket: ${secondary.bucket}
          region: ${secondary.bucketRegion}
          trafficDialPercentage: 100
      mrap: ${exampleAwsS3controlMultiRegionAccessPoint.arn}

Import

Identity Schema

Required

  • mrap (String) ARN 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 Point Routes using the mrap argument. For example:

$ pulumi import aws:s3control/multiRegionAccessPointRoutes:MultiRegionAccessPointRoutes example arn:aws:s3::0123456789012:accesspoint/example

Constructors

MultiRegionAccessPointRoutes(String name, {MultiRegionAccessPointRoutesArgs? args, CustomResourceOptions? options})
Creates a new MultiRegionAccessPointRoutes. name The Pulumi resource name. args Arguments used to configure this MultiRegionAccessPointRoutes. The set of arguments for MultiRegionAccessPointRoutes. options Resource options controlling this resource's behavior.
MultiRegionAccessPointRoutes.reference(String urn)
Creates a typed reference to an existing MultiRegionAccessPointRoutes 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 Terraform AWS provider.
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
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
mrap ↔ Output<String>
ARN 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
routes ↔ Output<List<MultiRegionAccessPointRoutesRoute>>
Route configurations. At least one route must have a trafficDialPercentage of 100. See route below.
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, {MultiRegionAccessPointRoutesState? state, CustomResourceOptions? options}) → MultiRegionAccessPointRoutes
Gets an existing MultiRegionAccessPointRoutes resource's state with the given name and id.