CustomRoutingAccelerator class

Creates a Global Accelerator custom routing accelerator.

Example Usage

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

const example = new aws.globalaccelerator.CustomRoutingAccelerator("example", {
    attributes: {
        flowLogsEnabled: true,
        flowLogsS3Bucket: "example-bucket",
        flowLogsS3Prefix: "flow-logs/",
    },
    name: "Example",
    ipAddressType: "IPV4",
    ipAddresses: ["1.2.3.4"],
    enabled: true,
});
import pulumi
import pulumi_aws as aws

example = aws.globalaccelerator.CustomRoutingAccelerator("example",
    attributes={
        "flow_logs_enabled": True,
        "flow_logs_s3_bucket": "example-bucket",
        "flow_logs_s3_prefix": "flow-logs/",
    },
    name="Example",
    ip_address_type="IPV4",
    ip_addresses=["1.2.3.4"],
    enabled=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.GlobalAccelerator.CustomRoutingAccelerator("example", new()
    {
        Attributes = new Aws.GlobalAccelerator.Inputs.CustomRoutingAcceleratorAttributesArgs
        {
            FlowLogsEnabled = true,
            FlowLogsS3Bucket = "example-bucket",
            FlowLogsS3Prefix = "flow-logs/",
        },
        Name = "Example",
        IpAddressType = "IPV4",
        IpAddresses = new[]
        {
            "1.2.3.4",
        },
        Enabled = true,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/globalaccelerator"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := globalaccelerator.NewCustomRoutingAccelerator(ctx, "example", &globalaccelerator.CustomRoutingAcceleratorArgs{
			Attributes: &globalaccelerator.CustomRoutingAcceleratorAttributesArgs{
				FlowLogsEnabled:  pulumi.Bool(true),
				FlowLogsS3Bucket: pulumi.String("example-bucket"),
				FlowLogsS3Prefix: pulumi.String("flow-logs/"),
			},
			Name:          pulumi.String("Example"),
			IpAddressType: pulumi.String("IPV4"),
			IpAddresses: pulumi.StringArray{
				pulumi.String("1.2.3.4"),
			},
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_globalaccelerator_customroutingaccelerator" "example" {
  attributes = {
    flow_logs_enabled   = true
    flow_logs_s3_bucket = "example-bucket"
    flow_logs_s3_prefix = "flow-logs/"
  }
  name            = "Example"
  ip_address_type = "IPV4"
  ip_addresses    = ["1.2.3.4"]
  enabled         = true
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.globalaccelerator.CustomRoutingAccelerator;
import com.pulumi.aws.globalaccelerator.CustomRoutingAcceleratorArgs;
import com.pulumi.aws.globalaccelerator.inputs.CustomRoutingAcceleratorAttributesArgs;
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 CustomRoutingAccelerator("example", CustomRoutingAcceleratorArgs.builder()
            .attributes(CustomRoutingAcceleratorAttributesArgs.builder()
                .flowLogsEnabled(true)
                .flowLogsS3Bucket("example-bucket")
                .flowLogsS3Prefix("flow-logs/")
                .build())
            .name("Example")
            .ipAddressType("IPV4")
            .ipAddresses("1.2.3.4")
            .enabled(true)
            .build());

    }
}
resources:
  example:
    type: aws:globalaccelerator:CustomRoutingAccelerator
    properties:
      attributes:
        flowLogsEnabled: true
        flowLogsS3Bucket: example-bucket
        flowLogsS3Prefix: flow-logs/
      name: Example
      ipAddressType: IPV4
      ipAddresses:
        - 1.2.3.4
      enabled: true

Import

Identity Schema

Required

  • arn (String) ARN of the Global Accelerator custom routing accelerator.

Using pulumi import, import Global Accelerator custom routing accelerators using the arn. For example:

$ pulumi import aws:globalaccelerator/customRoutingAccelerator:CustomRoutingAccelerator example arn:aws:globalaccelerator::111111111111:accelerator/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Constructors

CustomRoutingAccelerator(String name, {CustomRoutingAcceleratorArgs? args, CustomResourceOptions? options})
Creates a new CustomRoutingAccelerator. name The Pulumi resource name. args Arguments used to configure this CustomRoutingAccelerator. The set of arguments for CustomRoutingAccelerator. options Resource options controlling this resource's behavior.
CustomRoutingAccelerator.reference(String urn)
Creates a typed reference to an existing CustomRoutingAccelerator resource.

Properties

arn ↔ Output<String>
ARN of the custom accelerator.
latefinal
attributes ↔ Output<CustomRoutingAcceleratorAttributes?>
The attributes of the accelerator. Fields documented below.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dnsName ↔ Output<String>
The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
latefinal
enabled ↔ Output<bool?>
Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
hostedZoneId ↔ Output<String>
  • The Global Accelerator Route 53 zone ID that can be used to route an Alias Resource Record Set to the Global Accelerator. This attribute is simply an alias for the zone ID Z2BJ6XQ5FK7U4H.
  • latefinal
    id ↔ Output<String>
    getter/setter pairinherited
    ipAddresses ↔ Output<List<String>?>
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    latefinal
    ipAddressType ↔ Output<String?>
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    latefinal
    ipSets ↔ Output<List<CustomRoutingAcceleratorIpSet>>
    IP address set associated with the accelerator.
    latefinal
    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>
    The name of a custom routing accelerator.
    latefinal
    resourceTransforms → List<ResourceTransform>
    Inherited/explicit async transforms.
    no setterinherited
    runtimeType → Type
    A representation of the runtime type of the object.
    no setterinherited
    tags ↔ Output<Map<String, String>?>
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    latefinal
    tagsAll ↔ Output<Map<String, String>>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    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, {CustomRoutingAcceleratorState? state, CustomResourceOptions? options}) → CustomRoutingAccelerator
    Gets an existing CustomRoutingAccelerator resource's state with the given name and id.