AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

getAccelerator

Provides information about a Global Accelerator accelerator.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Config();
        var acceleratorArn = config.Get("acceleratorArn") ?? "";
        var acceleratorName = config.Get("acceleratorName") ?? "";
        var example = Output.Create(Aws.GlobalAccelerator.GetAccelerator.InvokeAsync(new Aws.GlobalAccelerator.GetAcceleratorArgs
        {
            Arn = acceleratorArn,
            Name = acceleratorName,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = Config.of();
        final var acceleratorArn = config.get("acceleratorArn").orElse("");
        final var acceleratorName = config.get("acceleratorName").orElse("");
        final var example = Output.of(GlobalacceleratorFunctions.getAccelerator(GetAcceleratorArgs.builder()
            .arn(acceleratorArn)
            .name(acceleratorName)
            .build()));

        }
}
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)
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,
});
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,
                    name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAcceleratorResult
def get_accelerator_output(arn: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    tags: Optional[pulumi.Input[Mapping[str, 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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:globalaccelerator/getAccelerator:getAccelerator
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Arn string

The full ARN of the Global Accelerator.

Name string

The unique name of the Global Accelerator.

Tags Dictionary<string, string>
Arn string

The full ARN of the Global Accelerator.

Name string

The unique name of the Global Accelerator.

Tags map[string]string
arn String

The full ARN of the Global Accelerator.

name String

The unique name of the Global Accelerator.

tags Map
arn string

The full ARN of the Global Accelerator.

name string

The unique name of the Global Accelerator.

tags {[key: string]: string}
arn str

The full ARN of the Global Accelerator.

name str

The unique name of the Global Accelerator.

tags Mapping[str, str]
arn String

The full ARN of the Global Accelerator.

name String

The unique name of the Global Accelerator.

tags Map

getAccelerator Result

The following output properties are available:

Arn string
Attributes List<GetAcceleratorAttribute>
DnsName string
Enabled bool
HostedZoneId string
Id string

The provider-assigned unique ID for this managed resource.

IpAddressType string
IpSets List<GetAcceleratorIpSet>
Name string
Tags Dictionary<string, string>
Arn string
Attributes []GetAcceleratorAttribute
DnsName string
Enabled bool
HostedZoneId string
Id string

The provider-assigned unique ID for this managed resource.

IpAddressType string
IpSets []GetAcceleratorIpSet
Name string
Tags map[string]string
arn String
attributes ListAcceleratorAttribute>
dnsName String
enabled Boolean
hostedZoneId String
id String

The provider-assigned unique ID for this managed resource.

ipAddressType String
ipSets ListAcceleratorIpSet>
name String
tags Map
arn string
attributes GetAcceleratorAttribute[]
dnsName string
enabled boolean
hostedZoneId string
id string

The provider-assigned unique ID for this managed resource.

ipAddressType string
ipSets GetAcceleratorIpSet[]
name string
tags {[key: string]: string}
arn str
attributes Sequence[GetAcceleratorAttribute]
dns_name str
enabled bool
hosted_zone_id str
id str

The provider-assigned unique ID for this managed resource.

ip_address_type str
ip_sets Sequence[GetAcceleratorIpSet]
name str
tags Mapping[str, str]
arn String
attributes List
dnsName String
enabled Boolean
hostedZoneId String
id String

The provider-assigned unique ID for this managed resource.

ipAddressType String
ipSets List
name String
tags Map

Supporting Types

GetAcceleratorAttribute

GetAcceleratorIpSet

IpAddresses List<string>
IpFamily string
IpAddresses []string
IpFamily string
ipAddresses string[]
ipFamily string
ip_addresses Sequence[str]
ip_family str

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.