AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
aws.globalaccelerator.getAccelerator
Explore with Pulumi AI
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/v6/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.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) {
        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}
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?: InvokeOptions): Output<GetAcceleratorResult>def get_accelerator(arn: Optional[str] = None,
                    id: Optional[str] = None,
                    name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAcceleratorResult
def get_accelerator_output(arn: Optional[pulumi.Input[str]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = 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 CompletableFuture<GetAcceleratorResult> getAccelerator(GetAcceleratorArgs args, InvokeOptions options)
public static Output<GetAcceleratorResult> getAccelerator(GetAcceleratorArgs args, InvokeOptions options)
fn::invoke:
  function: aws:globalaccelerator/getAccelerator:getAccelerator
  arguments:
    # arguments dictionaryThe following arguments are supported:
getAccelerator Result
The following output properties are available:
- Arn string
 - Attributes
List<Get
Accelerator Attribute>  - Dns
Name string - Dual
Stack stringDns Name  - Enabled bool
 - Hosted
Zone stringId  - Id string
 - Ip
Address stringType  - Ip
Sets List<GetAccelerator Ip Set>  - Name string
 - Dictionary<string, string>
 
- Arn string
 - Attributes
[]Get
Accelerator Attribute  - Dns
Name string - Dual
Stack stringDns Name  - Enabled bool
 - Hosted
Zone stringId  - Id string
 - Ip
Address stringType  - Ip
Sets []GetAccelerator Ip Set  - Name string
 - map[string]string
 
- arn String
 - attributes
List<Get
Accelerator Attribute>  - dns
Name String - dual
Stack StringDns Name  - enabled Boolean
 - hosted
Zone StringId  - id String
 - ip
Address StringType  - ip
Sets List<GetAccelerator Ip Set>  - name String
 - Map<String,String>
 
- arn string
 - attributes
Get
Accelerator Attribute[]  - dns
Name string - dual
Stack stringDns Name  - enabled boolean
 - hosted
Zone stringId  - id string
 - ip
Address stringType  - ip
Sets GetAccelerator Ip Set[]  - name string
 - {[key: string]: string}
 
- arn str
 - attributes
Sequence[Get
Accelerator Attribute]  - dns_
name str - dual_
stack_ strdns_ name  - enabled bool
 - hosted_
zone_ strid  - id str
 - ip_
address_ strtype  - ip_
sets Sequence[GetAccelerator Ip Set]  - name str
 - Mapping[str, str]
 
- arn String
 - attributes List<Property Map>
 - dns
Name String - dual
Stack StringDns Name  - enabled Boolean
 - hosted
Zone StringId  - id String
 - ip
Address StringType  - ip
Sets List<Property Map> - name String
 - Map<String>
 
Supporting Types
GetAcceleratorAttribute  
- Flow
Logs boolEnabled  - Flow
Logs stringS3Bucket  - Flow
Logs stringS3Prefix  
- Flow
Logs boolEnabled  - Flow
Logs stringS3Bucket  - Flow
Logs stringS3Prefix  
- flow
Logs BooleanEnabled  - flow
Logs StringS3Bucket  - flow
Logs StringS3Prefix  
- flow
Logs booleanEnabled  - flow
Logs stringS3Bucket  - flow
Logs stringS3Prefix  
- flow
Logs BooleanEnabled  - flow
Logs StringS3Bucket  - flow
Logs StringS3Prefix  
GetAcceleratorIpSet   
- Ip
Addresses List<string> - Ip
Family string 
- Ip
Addresses []string - Ip
Family string 
- ip
Addresses List<String> - ip
Family String 
- ip
Addresses string[] - ip
Family string 
- ip_
addresses Sequence[str] - ip_
family str 
- ip
Addresses List<String> - ip
Family String 
Package Details
- Repository
 - AWS Classic pulumi/pulumi-aws
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
awsTerraform Provider.