Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. globalaccelerator
  6. getAccelerator
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.globalaccelerator.getAccelerator

aws logo aws logo
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Provides information about a Global Accelerator accelerator.

    Example Usage

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

const config = new pulumi.Config();
const acceleratorArn = config.get("acceleratorArn") || "";
const acceleratorName = config.get("acceleratorName") || "";
const example = aws.globalaccelerator.getAccelerator({
    arn: acceleratorArn,
    name: acceleratorName,
});

    import pulumi
import pulumi_aws as aws

config = pulumi.Config()
accelerator_arn = config.get("acceleratorArn")
if accelerator_arn is None:
    accelerator_arn = ""
accelerator_name = config.get("acceleratorName")
if accelerator_name is None:
    accelerator_name = ""
example = aws.globalaccelerator.get_accelerator(arn=accelerator_arn,
    name=accelerator_name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		acceleratorArn := ""
		if param := cfg.Get("acceleratorArn"); param != "" {
			acceleratorArn = param
		}
		acceleratorName := ""
		if param := cfg.Get("acceleratorName"); param != "" {
			acceleratorName = param
		}
		_, err := globalaccelerator.LookupAccelerator(ctx, &globalaccelerator.LookupAcceleratorArgs{
			Arn:  pulumi.StringRef(acceleratorArn),
			Name: pulumi.StringRef(acceleratorName),
		}, nil)
		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 config = new Config();
    var acceleratorArn = config.Get("acceleratorArn") ?? "";
    var acceleratorName = config.Get("acceleratorName") ?? "";
    var example = Aws.GlobalAccelerator.GetAccelerator.Invoke(new()
    {
        Arn = acceleratorArn,
        Name = acceleratorName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.globalaccelerator.GlobalacceleratorFunctions;
import com.pulumi.aws.globalaccelerator.inputs.GetAcceleratorArgs;
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) {
        final var config = ctx.config();
        final var acceleratorArn = config.get("acceleratorArn").orElse("");
        final var acceleratorName = config.get("acceleratorName").orElse("");
        final var example = GlobalacceleratorFunctions.getAccelerator(GetAcceleratorArgs.builder()
            .arn(acceleratorArn)
            .name(acceleratorName)
            .build());

    }
}

    configuration:
  acceleratorArn:
    type: string
    default: ""
  acceleratorName:
    type: string
    default: ""
variables:
  example:
    fn::invoke:
      function: aws:globalaccelerator:getAccelerator
      arguments:
        arn: ${acceleratorArn}
        name: ${acceleratorName}

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_globalaccelerator_accelerator" "example" {
  arn  = var.acceleratorArn
  name = var.acceleratorName
}

variable "acceleratorArn" {
  type    = string
  default = ""
}
variable "acceleratorName" {
  type    = string
  default = ""
}

    Using getAccelerator

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAccelerator(args: GetAcceleratorArgs, opts?: InvokeOptions): Promise<GetAcceleratorResult>
function getAcceleratorOutput(args: GetAcceleratorOutputArgs, opts?: InvokeOutputOptions): Output<GetAcceleratorResult>
    def get_accelerator(arn: Optional[str] = None,
                    name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAcceleratorResult
def get_accelerator_output(arn: pulumi.Input[Optional[str]] = None,
                    name: pulumi.Input[Optional[str]] = None,
                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetAcceleratorResult]
    func LookupAccelerator(ctx *Context, args *LookupAcceleratorArgs, opts ...InvokeOption) (*LookupAcceleratorResult, error)
func LookupAcceleratorOutput(ctx *Context, args *LookupAcceleratorOutputArgs, opts ...InvokeOption) LookupAcceleratorResultOutput

    > Note: This function is named LookupAccelerator in the Go SDK.

    public static class GetAccelerator 
{
    public static Task<GetAcceleratorResult> InvokeAsync(GetAcceleratorArgs args, InvokeOptions? opts = null)
    public static Output<GetAcceleratorResult> Invoke(GetAcceleratorInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetAcceleratorResult> Invoke(GetAcceleratorInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetAcceleratorResult> getAccelerator(GetAcceleratorArgs args, InvokeOptions options)
public static Output<GetAcceleratorResult> getAccelerator(GetAcceleratorArgs args, InvokeOptions options)
public static Output<GetAcceleratorResult> getAccelerator(GetAcceleratorArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws:globalaccelerator/getAccelerator:getAccelerator
  arguments:
    # arguments dictionary
    data "aws_globalaccelerator_get_accelerator" "name" {
    # arguments
}

    The following arguments are supported:

    Arn string
    Full ARN of the Global Accelerator.
    Name string

    Unique name of the Global Accelerator.

    NOTE: When both arn and name are specified, arn takes precedence.

    Arn string
    Full ARN of the Global Accelerator.
    Name string

    Unique name of the Global Accelerator.

    NOTE: When both arn and name are specified, arn takes precedence.

    arn string
    Full ARN of the Global Accelerator.
    name string

    Unique name of the Global Accelerator.

    NOTE: When both arn and name are specified, arn takes precedence.

    arn String
    Full ARN of the Global Accelerator.
    name String

    Unique name of the Global Accelerator.

    NOTE: When both arn and name are specified, arn takes precedence.

    arn string
    Full ARN of the Global Accelerator.
    name string

    Unique name of the Global Accelerator.

    NOTE: When both arn and name are specified, arn takes precedence.

    arn str
    Full ARN of the Global Accelerator.
    name str

    Unique name of the Global Accelerator.

    NOTE: When both arn and name are specified, arn takes precedence.

    arn String
    Full ARN of the Global Accelerator.
    name String

    Unique name of the Global Accelerator.

    NOTE: When both arn and name are specified, arn takes precedence.

    getAccelerator Result

    The following output properties are available:

    Arn string
    Attributes List<GetAcceleratorAttribute>
    Attributes of the accelerator. See attributes below.
    DnsName string
    DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    DualStackDnsName string
    DNS name that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
    Enabled bool
    Whether the accelerator is enabled.
    HostedZoneId string
    Global Accelerator Route 53 zone ID used to route an Alias Resource Record Set to the accelerator.
    Id string
    IpAddressType string
    Value for the address type.
    IpSets List<GetAcceleratorIpSet>
    IP address set associated with the accelerator. See ipSets below.
    Name string
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    Arn string
    Attributes []GetAcceleratorAttribute
    Attributes of the accelerator. See attributes below.
    DnsName string
    DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    DualStackDnsName string
    DNS name that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
    Enabled bool
    Whether the accelerator is enabled.
    HostedZoneId string
    Global Accelerator Route 53 zone ID used to route an Alias Resource Record Set to the accelerator.
    Id string
    IpAddressType string
    Value for the address type.
    IpSets []GetAcceleratorIpSet
    IP address set associated with the accelerator. See ipSets below.
    Name string
    Tags map[string]string
    Map of tags assigned to the resource.
    arn string
    attributes list(object)
    Attributes of the accelerator. See attributes below.
    dns_name string
    DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dual_stack_dns_name string
    DNS name that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
    enabled bool
    Whether the accelerator is enabled.
    hosted_zone_id string
    Global Accelerator Route 53 zone ID used to route an Alias Resource Record Set to the accelerator.
    id string
    ip_address_type string
    Value for the address type.
    ip_sets list(object)
    IP address set associated with the accelerator. See ipSets below.
    name string
    tags map(string)
    Map of tags assigned to the resource.
    arn String
    attributes List<GetAcceleratorAttribute>
    Attributes of the accelerator. See attributes below.
    dnsName String
    DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dualStackDnsName String
    DNS name that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
    enabled Boolean
    Whether the accelerator is enabled.
    hostedZoneId String
    Global Accelerator Route 53 zone ID used to route an Alias Resource Record Set to the accelerator.
    id String
    ipAddressType String
    Value for the address type.
    ipSets List<GetAcceleratorIpSet>
    IP address set associated with the accelerator. See ipSets below.
    name String
    tags Map<String,String>
    Map of tags assigned to the resource.
    arn string
    attributes GetAcceleratorAttribute[]
    Attributes of the accelerator. See attributes below.
    dnsName string
    DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dualStackDnsName string
    DNS name that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
    enabled boolean
    Whether the accelerator is enabled.
    hostedZoneId string
    Global Accelerator Route 53 zone ID used to route an Alias Resource Record Set to the accelerator.
    id string
    ipAddressType string
    Value for the address type.
    ipSets GetAcceleratorIpSet[]
    IP address set associated with the accelerator. See ipSets below.
    name string
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    arn str
    attributes Sequence[GetAcceleratorAttribute]
    Attributes of the accelerator. See attributes below.
    dns_name str
    DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dual_stack_dns_name str
    DNS name that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
    enabled bool
    Whether the accelerator is enabled.
    hosted_zone_id str
    Global Accelerator Route 53 zone ID used to route an Alias Resource Record Set to the accelerator.
    id str
    ip_address_type str
    Value for the address type.
    ip_sets Sequence[GetAcceleratorIpSet]
    IP address set associated with the accelerator. See ipSets below.
    name str
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    arn String
    attributes List<Property Map>
    Attributes of the accelerator. See attributes below.
    dnsName String
    DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.
    dualStackDnsName String
    DNS name that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
    enabled Boolean
    Whether the accelerator is enabled.
    hostedZoneId String
    Global Accelerator Route 53 zone ID used to route an Alias Resource Record Set to the accelerator.
    id String
    ipAddressType String
    Value for the address type.
    ipSets List<Property Map>
    IP address set associated with the accelerator. See ipSets below.
    name String
    tags Map<String>
    Map of tags assigned to the resource.

    Supporting Types

    GetAcceleratorAttribute

    FlowLogsEnabled bool
    Whether flow logs are enabled.
    FlowLogsS3Bucket string
    Name of the Amazon S3 bucket for the flow logs.
    FlowLogsS3Prefix string
    Prefix for the location in the Amazon S3 bucket for the flow logs.
    FlowLogsEnabled bool
    Whether flow logs are enabled.
    FlowLogsS3Bucket string
    Name of the Amazon S3 bucket for the flow logs.
    FlowLogsS3Prefix string
    Prefix for the location in the Amazon S3 bucket for the flow logs.
    flow_logs_enabled bool
    Whether flow logs are enabled.
    flow_logs_s3_bucket string
    Name of the Amazon S3 bucket for the flow logs.
    flow_logs_s3_prefix string
    Prefix for the location in the Amazon S3 bucket for the flow logs.
    flowLogsEnabled Boolean
    Whether flow logs are enabled.
    flowLogsS3Bucket String
    Name of the Amazon S3 bucket for the flow logs.
    flowLogsS3Prefix String
    Prefix for the location in the Amazon S3 bucket for the flow logs.
    flowLogsEnabled boolean
    Whether flow logs are enabled.
    flowLogsS3Bucket string
    Name of the Amazon S3 bucket for the flow logs.
    flowLogsS3Prefix string
    Prefix for the location in the Amazon S3 bucket for the flow logs.
    flow_logs_enabled bool
    Whether flow logs are enabled.
    flow_logs_s3_bucket str
    Name of the Amazon S3 bucket for the flow logs.
    flow_logs_s3_prefix str
    Prefix for the location in the Amazon S3 bucket for the flow logs.
    flowLogsEnabled Boolean
    Whether flow logs are enabled.
    flowLogsS3Bucket String
    Name of the Amazon S3 bucket for the flow logs.
    flowLogsS3Prefix String
    Prefix for the location in the Amazon S3 bucket for the flow logs.

    GetAcceleratorIpSet

    IpAddresses List<string>
    List of IP addresses in the IP address set.
    IpFamily string
    Type of IP addresses included in this IP set.
    IpAddresses []string
    List of IP addresses in the IP address set.
    IpFamily string
    Type of IP addresses included in this IP set.
    ip_addresses list(string)
    List of IP addresses in the IP address set.
    ip_family string
    Type of IP addresses included in this IP set.
    ipAddresses List<String>
    List of IP addresses in the IP address set.
    ipFamily String
    Type of IP addresses included in this IP set.
    ipAddresses string[]
    List of IP addresses in the IP address set.
    ipFamily string
    Type of IP addresses included in this IP set.
    ip_addresses Sequence[str]
    List of IP addresses in the IP address set.
    ip_family str
    Type of IP addresses included in this IP set.
    ipAddresses List<String>
    List of IP addresses in the IP address set.
    ipFamily String
    Type of IP addresses included in this IP set.

    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 logo
    Viewing docs for AWS v7.52.1
    published on Wednesday, Oct 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial