Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. globalaccelerator
  5. CustomRoutingAccelerator
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

aws.globalaccelerator.CustomRoutingAccelerator

Explore with Pulumi AI

aws logo
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

    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", {
    name: "Example",
    ipAddressType: "IPV4",
    ipAddresses: ["1.2.3.4"],
    enabled: true,
    attributes: {
        flowLogsEnabled: true,
        flowLogsS3Bucket: "example-bucket",
        flowLogsS3Prefix: "flow-logs/",
    },
});

    import pulumi
import pulumi_aws as aws

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

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name:          pulumi.String("Example"),
			IpAddressType: pulumi.String("IPV4"),
			IpAddresses: pulumi.StringArray{
				pulumi.String("1.2.3.4"),
			},
			Enabled: pulumi.Bool(true),
			Attributes: &globalaccelerator.CustomRoutingAcceleratorAttributesArgs{
				FlowLogsEnabled:  pulumi.Bool(true),
				FlowLogsS3Bucket: pulumi.String("example-bucket"),
				FlowLogsS3Prefix: pulumi.String("flow-logs/"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        Name = "Example",
        IpAddressType = "IPV4",
        IpAddresses = new[]
        {
            "1.2.3.4",
        },
        Enabled = true,
        Attributes = new Aws.GlobalAccelerator.Inputs.CustomRoutingAcceleratorAttributesArgs
        {
            FlowLogsEnabled = true,
            FlowLogsS3Bucket = "example-bucket",
            FlowLogsS3Prefix = "flow-logs/",
        },
    });

});

    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.List;
import java.util.ArrayList;
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()
            .name("Example")
            .ipAddressType("IPV4")
            .ipAddresses("1.2.3.4")
            .enabled(true)
            .attributes(CustomRoutingAcceleratorAttributesArgs.builder()
                .flowLogsEnabled(true)
                .flowLogsS3Bucket("example-bucket")
                .flowLogsS3Prefix("flow-logs/")
                .build())
            .build());

    }
}

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

    Create CustomRoutingAccelerator Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CustomRoutingAccelerator(name: string, args?: CustomRoutingAcceleratorArgs, opts?: CustomResourceOptions);
    @overload
def CustomRoutingAccelerator(resource_name: str,
                             args: Optional[CustomRoutingAcceleratorArgs] = None,
                             opts: Optional[ResourceOptions] = None)

@overload
def CustomRoutingAccelerator(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             attributes: Optional[CustomRoutingAcceleratorAttributesArgs] = None,
                             enabled: Optional[bool] = None,
                             ip_address_type: Optional[str] = None,
                             ip_addresses: Optional[Sequence[str]] = None,
                             name: Optional[str] = None,
                             tags: Optional[Mapping[str, str]] = None)
    func NewCustomRoutingAccelerator(ctx *Context, name string, args *CustomRoutingAcceleratorArgs, opts ...ResourceOption) (*CustomRoutingAccelerator, error)
    public CustomRoutingAccelerator(string name, CustomRoutingAcceleratorArgs? args = null, CustomResourceOptions? opts = null)
    public CustomRoutingAccelerator(String name, CustomRoutingAcceleratorArgs args)
public CustomRoutingAccelerator(String name, CustomRoutingAcceleratorArgs args, CustomResourceOptions options)

    type: aws:globalaccelerator:CustomRoutingAccelerator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CustomRoutingAcceleratorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CustomRoutingAcceleratorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CustomRoutingAcceleratorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomRoutingAcceleratorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomRoutingAcceleratorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var customRoutingAcceleratorResource = new Aws.GlobalAccelerator.CustomRoutingAccelerator("customRoutingAcceleratorResource", new()
{
    Attributes = new Aws.GlobalAccelerator.Inputs.CustomRoutingAcceleratorAttributesArgs
    {
        FlowLogsEnabled = false,
        FlowLogsS3Bucket = "string",
        FlowLogsS3Prefix = "string",
    },
    Enabled = false,
    IpAddressType = "string",
    IpAddresses = new[]
    {
        "string",
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := globalaccelerator.NewCustomRoutingAccelerator(ctx, "customRoutingAcceleratorResource", &globalaccelerator.CustomRoutingAcceleratorArgs{
	Attributes: &globalaccelerator.CustomRoutingAcceleratorAttributesArgs{
		FlowLogsEnabled:  pulumi.Bool(false),
		FlowLogsS3Bucket: pulumi.String("string"),
		FlowLogsS3Prefix: pulumi.String("string"),
	},
	Enabled:       pulumi.Bool(false),
	IpAddressType: pulumi.String("string"),
	IpAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var customRoutingAcceleratorResource = new CustomRoutingAccelerator("customRoutingAcceleratorResource", CustomRoutingAcceleratorArgs.builder()
    .attributes(CustomRoutingAcceleratorAttributesArgs.builder()
        .flowLogsEnabled(false)
        .flowLogsS3Bucket("string")
        .flowLogsS3Prefix("string")
        .build())
    .enabled(false)
    .ipAddressType("string")
    .ipAddresses("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    custom_routing_accelerator_resource = aws.globalaccelerator.CustomRoutingAccelerator("customRoutingAcceleratorResource",
    attributes={
        "flow_logs_enabled": False,
        "flow_logs_s3_bucket": "string",
        "flow_logs_s3_prefix": "string",
    },
    enabled=False,
    ip_address_type="string",
    ip_addresses=["string"],
    name="string",
    tags={
        "string": "string",
    })

    const customRoutingAcceleratorResource = new aws.globalaccelerator.CustomRoutingAccelerator("customRoutingAcceleratorResource", {
    attributes: {
        flowLogsEnabled: false,
        flowLogsS3Bucket: "string",
        flowLogsS3Prefix: "string",
    },
    enabled: false,
    ipAddressType: "string",
    ipAddresses: ["string"],
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:globalaccelerator:CustomRoutingAccelerator
properties:
    attributes:
        flowLogsEnabled: false
        flowLogsS3Bucket: string
        flowLogsS3Prefix: string
    enabled: false
    ipAddressType: string
    ipAddresses:
        - string
    name: string
    tags:
        string: string

    CustomRoutingAccelerator Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CustomRoutingAccelerator resource accepts the following input properties:

    Attributes CustomRoutingAcceleratorAttributes
    The attributes of the accelerator. Fields documented below.
    Enabled bool
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    IpAddressType string
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    IpAddresses 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.
    Name string
    The name of a custom routing accelerator.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Attributes CustomRoutingAcceleratorAttributesArgs
    The attributes of the accelerator. Fields documented below.
    Enabled bool
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    IpAddressType string
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    IpAddresses []string
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    Name string
    The name of a custom routing accelerator.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    attributes CustomRoutingAcceleratorAttributes
    The attributes of the accelerator. Fields documented below.
    enabled Boolean
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    ipAddressType String
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    ipAddresses 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.
    name String
    The name of a custom routing accelerator.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    attributes CustomRoutingAcceleratorAttributes
    The attributes of the accelerator. Fields documented below.
    enabled boolean
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    ipAddressType string
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    ipAddresses string[]
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    name string
    The name of a custom routing accelerator.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    attributes CustomRoutingAcceleratorAttributesArgs
    The attributes of the accelerator. Fields documented below.
    enabled bool
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    ip_address_type str
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    ip_addresses Sequence[str]
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    name str
    The name of a custom routing accelerator.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    attributes Property Map
    The attributes of the accelerator. Fields documented below.
    enabled Boolean
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    ipAddressType String
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    ipAddresses 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.
    name String
    The name of a custom routing accelerator.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomRoutingAccelerator resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the custom accelerator.
    DnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    HostedZoneId 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpSets List<CustomRoutingAcceleratorIpSet>
    IP address set associated with the accelerator.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) of the custom accelerator.
    DnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    HostedZoneId 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpSets []CustomRoutingAcceleratorIpSet
    IP address set associated with the accelerator.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the custom accelerator.
    dnsName String
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    hostedZoneId 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.
    id String
    The provider-assigned unique ID for this managed resource.
    ipSets List<CustomRoutingAcceleratorIpSet>
    IP address set associated with the accelerator.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) of the custom accelerator.
    dnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    hostedZoneId 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.
    id string
    The provider-assigned unique ID for this managed resource.
    ipSets CustomRoutingAcceleratorIpSet[]
    IP address set associated with the accelerator.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) of the custom accelerator.
    dns_name str
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    hosted_zone_id str
    • 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.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_sets Sequence[CustomRoutingAcceleratorIpSet]
    IP address set associated with the accelerator.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the custom accelerator.
    dnsName String
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    hostedZoneId 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.
    id String
    The provider-assigned unique ID for this managed resource.
    ipSets List<Property Map>
    IP address set associated with the accelerator.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing CustomRoutingAccelerator Resource

    Get an existing CustomRoutingAccelerator resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CustomRoutingAcceleratorState, opts?: CustomResourceOptions): CustomRoutingAccelerator
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        attributes: Optional[CustomRoutingAcceleratorAttributesArgs] = None,
        dns_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        hosted_zone_id: Optional[str] = None,
        ip_address_type: Optional[str] = None,
        ip_addresses: Optional[Sequence[str]] = None,
        ip_sets: Optional[Sequence[CustomRoutingAcceleratorIpSetArgs]] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> CustomRoutingAccelerator
    func GetCustomRoutingAccelerator(ctx *Context, name string, id IDInput, state *CustomRoutingAcceleratorState, opts ...ResourceOption) (*CustomRoutingAccelerator, error)
    public static CustomRoutingAccelerator Get(string name, Input<string> id, CustomRoutingAcceleratorState? state, CustomResourceOptions? opts = null)
    public static CustomRoutingAccelerator get(String name, Output<String> id, CustomRoutingAcceleratorState state, CustomResourceOptions options)
    resources:  _:    type: aws:globalaccelerator:CustomRoutingAccelerator    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) of the custom accelerator.
    Attributes CustomRoutingAcceleratorAttributes
    The attributes of the accelerator. Fields documented below.
    DnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    Enabled bool
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    HostedZoneId 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.
    IpAddressType string
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    IpAddresses 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.
    IpSets List<CustomRoutingAcceleratorIpSet>
    IP address set associated with the accelerator.
    Name string
    The name of a custom routing accelerator.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) of the custom accelerator.
    Attributes CustomRoutingAcceleratorAttributesArgs
    The attributes of the accelerator. Fields documented below.
    DnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    Enabled bool
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    HostedZoneId 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.
    IpAddressType string
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    IpAddresses []string
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    IpSets []CustomRoutingAcceleratorIpSetArgs
    IP address set associated with the accelerator.
    Name string
    The name of a custom routing accelerator.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the custom accelerator.
    attributes CustomRoutingAcceleratorAttributes
    The attributes of the accelerator. Fields documented below.
    dnsName String
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    enabled Boolean
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    hostedZoneId 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.
    ipAddressType String
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    ipAddresses 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.
    ipSets List<CustomRoutingAcceleratorIpSet>
    IP address set associated with the accelerator.
    name String
    The name of a custom routing accelerator.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) of the custom accelerator.
    attributes CustomRoutingAcceleratorAttributes
    The attributes of the accelerator. Fields documented below.
    dnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    enabled boolean
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    hostedZoneId 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.
    ipAddressType string
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    ipAddresses string[]
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    ipSets CustomRoutingAcceleratorIpSet[]
    IP address set associated with the accelerator.
    name string
    The name of a custom routing accelerator.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) of the custom accelerator.
    attributes CustomRoutingAcceleratorAttributesArgs
    The attributes of the accelerator. Fields documented below.
    dns_name str
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    enabled bool
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    hosted_zone_id str
    • 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.
    ip_address_type str
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    ip_addresses Sequence[str]
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    ip_sets Sequence[CustomRoutingAcceleratorIpSetArgs]
    IP address set associated with the accelerator.
    name str
    The name of a custom routing accelerator.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the custom accelerator.
    attributes Property Map
    The attributes of the accelerator. Fields documented below.
    dnsName String
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    enabled Boolean
    Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.
    hostedZoneId 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.
    ipAddressType String
    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be "IPV4".
    ipAddresses 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.
    ipSets List<Property Map>
    IP address set associated with the accelerator.
    name String
    The name of a custom routing accelerator.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    CustomRoutingAcceleratorAttributes, CustomRoutingAcceleratorAttributesArgs

    FlowLogsEnabled bool
    Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.
    FlowLogsS3Bucket string
    The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    FlowLogsS3Prefix string
    The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    FlowLogsEnabled bool
    Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.
    FlowLogsS3Bucket string
    The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    FlowLogsS3Prefix string
    The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    flowLogsEnabled Boolean
    Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.
    flowLogsS3Bucket String
    The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    flowLogsS3Prefix String
    The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    flowLogsEnabled boolean
    Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.
    flowLogsS3Bucket string
    The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    flowLogsS3Prefix string
    The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    flow_logs_enabled bool
    Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.
    flow_logs_s3_bucket str
    The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    flow_logs_s3_prefix str
    The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    flowLogsEnabled Boolean
    Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.
    flowLogsS3Bucket String
    The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.
    flowLogsS3Prefix String
    The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

    CustomRoutingAcceleratorIpSet, CustomRoutingAcceleratorIpSetArgs

    IpAddresses 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.
    IpFamily string
    The type of IP addresses included in this IP set.
    IpAddresses []string
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    IpFamily string
    The type of IP addresses included in this IP set.
    ipAddresses 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.
    ipFamily String
    The type of IP addresses included in this IP set.
    ipAddresses string[]
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    ipFamily string
    The type of IP addresses included in this IP set.
    ip_addresses Sequence[str]
    The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.
    ip_family str
    The type of IP addresses included in this IP set.
    ipAddresses 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.
    ipFamily String
    The type of IP addresses included in this IP set.

    Import

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-aws