Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. globalaccelerator
  5. getAccelerator

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.globalaccelerator.getAccelerator

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::GlobalAccelerator::Accelerator

    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(accelerator_arn: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAcceleratorResult
def get_accelerator_output(accelerator_arn: 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-native:globalaccelerator:getAccelerator
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AcceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    AcceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    acceleratorArn String
    The Amazon Resource Name (ARN) of the accelerator.
    acceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    accelerator_arn str
    The Amazon Resource Name (ARN) of the accelerator.
    acceleratorArn String
    The Amazon Resource Name (ARN) of the accelerator.

    getAccelerator Result

    The following output properties are available:

    AcceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    DnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    DualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    Enabled bool
    Indicates whether an accelerator is enabled. The value is true or false.
    IpAddressType Pulumi.AwsNative.GlobalAccelerator.AcceleratorIpAddressType
    IP Address type.
    IpAddresses List<string>
    The IP addresses from BYOIP Prefix pool.
    Ipv4Addresses List<string>
    The IPv4 addresses assigned to the accelerator.
    Ipv6Addresses List<string>
    The IPv6 addresses assigned if the accelerator is dualstack
    Name string
    Name of accelerator.
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    AcceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    DnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    DualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    Enabled bool
    Indicates whether an accelerator is enabled. The value is true or false.
    IpAddressType AcceleratorIpAddressType
    IP Address type.
    IpAddresses []string
    The IP addresses from BYOIP Prefix pool.
    Ipv4Addresses []string
    The IPv4 addresses assigned to the accelerator.
    Ipv6Addresses []string
    The IPv6 addresses assigned if the accelerator is dualstack
    Name string
    Name of accelerator.
    Tags Tag

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    acceleratorArn String
    The Amazon Resource Name (ARN) of the accelerator.
    dnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    dualStackDnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    enabled Boolean
    Indicates whether an accelerator is enabled. The value is true or false.
    ipAddressType AcceleratorIpAddressType
    IP Address type.
    ipAddresses List<String>
    The IP addresses from BYOIP Prefix pool.
    ipv4Addresses List<String>
    The IPv4 addresses assigned to the accelerator.
    ipv6Addresses List<String>
    The IPv6 addresses assigned if the accelerator is dualstack
    name String
    Name of accelerator.
    tags List<Tag>

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    acceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    dnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    dualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    enabled boolean
    Indicates whether an accelerator is enabled. The value is true or false.
    ipAddressType AcceleratorIpAddressType
    IP Address type.
    ipAddresses string[]
    The IP addresses from BYOIP Prefix pool.
    ipv4Addresses string[]
    The IPv4 addresses assigned to the accelerator.
    ipv6Addresses string[]
    The IPv6 addresses assigned if the accelerator is dualstack
    name string
    Name of accelerator.
    tags Tag[]

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    accelerator_arn str
    The Amazon Resource Name (ARN) of the accelerator.
    dns_name str
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    dual_stack_dns_name str
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    enabled bool
    Indicates whether an accelerator is enabled. The value is true or false.
    ip_address_type AcceleratorIpAddressType
    IP Address type.
    ip_addresses Sequence[str]
    The IP addresses from BYOIP Prefix pool.
    ipv4_addresses Sequence[str]
    The IPv4 addresses assigned to the accelerator.
    ipv6_addresses Sequence[str]
    The IPv6 addresses assigned if the accelerator is dualstack
    name str
    Name of accelerator.
    tags Sequence[root_Tag]

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    acceleratorArn String
    The Amazon Resource Name (ARN) of the accelerator.
    dnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    dualStackDnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    enabled Boolean
    Indicates whether an accelerator is enabled. The value is true or false.
    ipAddressType "IPV4" | "DUAL_STACK"
    IP Address type.
    ipAddresses List<String>
    The IP addresses from BYOIP Prefix pool.
    ipv4Addresses List<String>
    The IPv4 addresses assigned to the accelerator.
    ipv6Addresses List<String>
    The IPv6 addresses assigned if the accelerator is dualstack
    name String
    Name of accelerator.
    tags List<Property Map>

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    Supporting Types

    AcceleratorIpAddressType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native