Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. globalaccelerator
  5. Accelerator
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.globalaccelerator.Accelerator

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Creates a Global Accelerator accelerator.

    Example Usage

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

const example = new aws.globalaccelerator.Accelerator("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.Accelerator("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.NewAccelerator(ctx, "example", &globalaccelerator.AcceleratorArgs{
			Name:          pulumi.String("Example"),
			IpAddressType: pulumi.String("IPV4"),
			IpAddresses: pulumi.StringArray{
				pulumi.String("1.2.3.4"),
			},
			Enabled: pulumi.Bool(true),
			Attributes: &globalaccelerator.AcceleratorAttributesArgs{
				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.Accelerator("example", new()
    {
        Name = "Example",
        IpAddressType = "IPV4",
        IpAddresses = new[]
        {
            "1.2.3.4",
        },
        Enabled = true,
        Attributes = new Aws.GlobalAccelerator.Inputs.AcceleratorAttributesArgs
        {
            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.Accelerator;
import com.pulumi.aws.globalaccelerator.AcceleratorArgs;
import com.pulumi.aws.globalaccelerator.inputs.AcceleratorAttributesArgs;
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 Accelerator("example", AcceleratorArgs.builder()
            .name("Example")
            .ipAddressType("IPV4")
            .ipAddresses("1.2.3.4")
            .enabled(true)
            .attributes(AcceleratorAttributesArgs.builder()
                .flowLogsEnabled(true)
                .flowLogsS3Bucket("example-bucket")
                .flowLogsS3Prefix("flow-logs/")
                .build())
            .build());

    }
}

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

    Create Accelerator Resource

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

    Constructor syntax

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

@overload
def Accelerator(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                attributes: Optional[AcceleratorAttributesArgs] = 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 NewAccelerator(ctx *Context, name string, args *AcceleratorArgs, opts ...ResourceOption) (*Accelerator, error)
    public Accelerator(string name, AcceleratorArgs? args = null, CustomResourceOptions? opts = null)
    public Accelerator(String name, AcceleratorArgs args)
public Accelerator(String name, AcceleratorArgs args, CustomResourceOptions options)

    type: aws:globalaccelerator:Accelerator
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 AcceleratorArgs
    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 AcceleratorArgs
    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 AcceleratorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AcceleratorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AcceleratorArgs
    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 acceleratorResource = new Aws.GlobalAccelerator.Accelerator("acceleratorResource", new()
{
    Attributes = new Aws.GlobalAccelerator.Inputs.AcceleratorAttributesArgs
    {
        FlowLogsEnabled = false,
        FlowLogsS3Bucket = "string",
        FlowLogsS3Prefix = "string",
    },
    Enabled = false,
    IpAddressType = "string",
    IpAddresses = new[]
    {
        "string",
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := globalaccelerator.NewAccelerator(ctx, "acceleratorResource", &globalaccelerator.AcceleratorArgs{
	Attributes: &globalaccelerator.AcceleratorAttributesArgs{
		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 acceleratorResource = new Accelerator("acceleratorResource", AcceleratorArgs.builder()
    .attributes(AcceleratorAttributesArgs.builder()
        .flowLogsEnabled(false)
        .flowLogsS3Bucket("string")
        .flowLogsS3Prefix("string")
        .build())
    .enabled(false)
    .ipAddressType("string")
    .ipAddresses("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    accelerator_resource = aws.globalaccelerator.Accelerator("acceleratorResource",
    attributes={
        "flowLogsEnabled": False,
        "flowLogsS3Bucket": "string",
        "flowLogsS3Prefix": "string",
    },
    enabled=False,
    ip_address_type="string",
    ip_addresses=["string"],
    name="string",
    tags={
        "string": "string",
    })

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

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

    Accelerator Resource Properties

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

    Inputs

    The Accelerator resource accepts the following input properties:

    Attributes AcceleratorAttributes
    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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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 the 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 AcceleratorAttributesArgs
    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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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 the 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 AcceleratorAttributes
    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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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 the 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 AcceleratorAttributes
    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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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 the 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 AcceleratorAttributesArgs
    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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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 the 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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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 the 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 Accelerator resource produces the following output properties:

    DnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    DualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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<AcceleratorIpSet>
    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.

    DnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    DualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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 []AcceleratorIpSet
    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.

    dnsName String
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dualStackDnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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<AcceleratorIpSet>
    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.

    dnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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 AcceleratorIpSet[]
    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.

    dns_name str
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dual_stack_dns_name str
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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[AcceleratorIpSet]
    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.

    dnsName String
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dualStackDnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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 Accelerator Resource

    Get an existing Accelerator 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?: AcceleratorState, opts?: CustomResourceOptions): Accelerator
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attributes: Optional[AcceleratorAttributesArgs] = None,
        dns_name: Optional[str] = None,
        dual_stack_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[AcceleratorIpSetArgs]] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Accelerator
    func GetAccelerator(ctx *Context, name string, id IDInput, state *AcceleratorState, opts ...ResourceOption) (*Accelerator, error)
    public static Accelerator Get(string name, Input<string> id, AcceleratorState? state, CustomResourceOptions? opts = null)
    public static Accelerator get(String name, Output<String> id, AcceleratorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Attributes AcceleratorAttributes
    The attributes of the accelerator. Fields documented below.
    DnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    DualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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<AcceleratorIpSet>
    IP address set associated with the accelerator.
    Name string
    The name of the 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.

    Attributes AcceleratorAttributesArgs
    The attributes of the accelerator. Fields documented below.
    DnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    DualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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 []AcceleratorIpSetArgs
    IP address set associated with the accelerator.
    Name string
    The name of the 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.

    attributes AcceleratorAttributes
    The attributes of the accelerator. Fields documented below.
    dnsName String
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dualStackDnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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<AcceleratorIpSet>
    IP address set associated with the accelerator.
    name String
    The name of the 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.

    attributes AcceleratorAttributes
    The attributes of the accelerator. Fields documented below.
    dnsName string
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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 AcceleratorIpSet[]
    IP address set associated with the accelerator.
    name string
    The name of the 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.

    attributes AcceleratorAttributesArgs
    The attributes of the accelerator. Fields documented below.
    dns_name str
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dual_stack_dns_name str
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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[AcceleratorIpSetArgs]
    IP address set associated with the accelerator.
    name str
    The name of the 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.

    attributes Property Map
    The attributes of the accelerator. Fields documented below.
    dnsName String
    The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dualStackDnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. For example, a1234567890abcdef.dualstack.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 value for the address type. Defaults to IPV4. Valid values: IPV4, DUAL_STACK.
    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 the 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

    AcceleratorAttributes, AcceleratorAttributesArgs

    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.

    AcceleratorIpSet, AcceleratorIpSetArgs

    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 accelerators using the arn. For example:

    $ pulumi import aws:globalaccelerator/accelerator:Accelerator 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.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws