MultiRegionEndpoint class
Manages an AWS SESv2 (Simple Email V2) Multi Region Endpoint (global endpoint). Traffic is split equally between the primary region (where the resource is created) and the secondary region specified in the details block.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sesv2.MultiRegionEndpoint("example", {
details: {
routesDetails: {
region: "example-alternate-region",
},
},
endpointName: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.sesv2.MultiRegionEndpoint("example",
details={
"routes_details": {
"region": "example-alternate-region",
},
},
endpoint_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SesV2.MultiRegionEndpoint("example", new()
{
Details = new Aws.SesV2.Inputs.MultiRegionEndpointDetailsArgs
{
RoutesDetails = new Aws.SesV2.Inputs.MultiRegionEndpointDetailsRoutesDetailsArgs
{
Region = "example-alternate-region",
},
},
EndpointName = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sesv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sesv2.NewMultiRegionEndpoint(ctx, "example", &sesv2.MultiRegionEndpointArgs{
Details: &sesv2.MultiRegionEndpointDetailsArgs{
RoutesDetails: &sesv2.MultiRegionEndpointDetailsRoutesDetailsArgs{
Region: pulumi.String("example-alternate-region"),
},
},
EndpointName: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sesv2_multiregionendpoint" "example" {
details = {
routes_details = {
region = "example-alternate-region"
}
}
endpoint_name = "example"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sesv2.MultiRegionEndpoint;
import com.pulumi.aws.sesv2.MultiRegionEndpointArgs;
import com.pulumi.aws.sesv2.inputs.MultiRegionEndpointDetailsArgs;
import com.pulumi.aws.sesv2.inputs.MultiRegionEndpointDetailsRoutesDetailsArgs;
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 MultiRegionEndpoint("example", MultiRegionEndpointArgs.builder()
.details(MultiRegionEndpointDetailsArgs.builder()
.routesDetails(MultiRegionEndpointDetailsRoutesDetailsArgs.builder()
.region("example-alternate-region")
.build())
.build())
.endpointName("example")
.build());
}
}
resources:
example:
type: aws:sesv2:MultiRegionEndpoint
properties:
details:
routesDetails:
region: example-alternate-region
endpointName: example
Constructors
- MultiRegionEndpoint(String name, {MultiRegionEndpointArgs? args, CustomResourceOptions? options})
-
Creates a new MultiRegionEndpoint.
nameThe Pulumi resource name.argsArguments used to configure this MultiRegionEndpoint. The set of arguments for MultiRegionEndpoint.optionsResource options controlling this resource's behavior. - MultiRegionEndpoint.reference(String urn)
- Creates a typed reference to an existing MultiRegionEndpoint resource.
Properties
-
arn
↔ Output<
String> -
ARN of the multi-region endpoint.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
details
↔ Output<
MultiRegionEndpointDetails?> -
Configuration details for the endpoint. See
detailsBlock below.latefinal -
endpointId
↔ Output<
String> -
ID assigned to the multi-region endpoint.
latefinal
-
endpointName
↔ Output<
String> -
Name of the multi-region endpoint.
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
-
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< MultiRegionEndpointRoute> > -
List of active routes. See
routesbelow.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Map of tags assigned to the resource. 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 -
timeouts
↔ Output<
MultiRegionEndpointTimeouts?> -
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, {MultiRegionEndpointState? state, CustomResourceOptions? options}) → MultiRegionEndpoint -
Gets an existing MultiRegionEndpoint resource's state with the given
nameandid.