amazonka-globalaccelerator-2.0: Amazon Global Accelerator SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GlobalAccelerator.Types.Accelerator

Description

 
Synopsis

Documentation

data Accelerator Source #

An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.

See: newAccelerator smart constructor.

Constructors

Accelerator' 

Fields

  • acceleratorArn :: Maybe Text

    The Amazon Resource Name (ARN) of the accelerator.

  • createdTime :: Maybe POSIX

    The date and time that the accelerator was created.

  • dnsName :: Maybe Text

    The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.

    The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

    If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.

    For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

  • dualStackDnsName :: Maybe Text

    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.

    The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.

    Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

    For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

  • enabled :: Maybe Bool

    Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

  • events :: Maybe [AcceleratorEvent]

    A history of changes that you make to an accelerator in Global Accelerator.

  • ipAddressType :: Maybe IpAddressType

    The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

  • ipSets :: Maybe [IpSet]

    The static IP addresses that Global Accelerator associates with the accelerator.

  • lastModifiedTime :: Maybe POSIX

    The date and time that the accelerator was last modified.

  • name :: Maybe Text

    The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

  • status :: Maybe AcceleratorStatus

    Describes the deployment status of the accelerator.

Instances

Instances details
FromJSON Accelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.Accelerator

Generic Accelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.Accelerator

Associated Types

type Rep Accelerator :: Type -> Type #

Read Accelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.Accelerator

Show Accelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.Accelerator

NFData Accelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.Accelerator

Methods

rnf :: Accelerator -> () #

Eq Accelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.Accelerator

Hashable Accelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.Accelerator

type Rep Accelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.Accelerator

type Rep Accelerator = D1 ('MetaData "Accelerator" "Amazonka.GlobalAccelerator.Types.Accelerator" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "Accelerator'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "acceleratorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "dnsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dualStackDnsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AcceleratorEvent])) :*: (S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType)) :*: S1 ('MetaSel ('Just "ipSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpSet])))) :*: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AcceleratorStatus)))))))

newAccelerator :: Accelerator Source #

Create a value of Accelerator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:acceleratorArn:Accelerator', accelerator_acceleratorArn - The Amazon Resource Name (ARN) of the accelerator.

$sel:createdTime:Accelerator', accelerator_createdTime - The date and time that the accelerator was created.

$sel:dnsName:Accelerator', accelerator_dnsName - The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.

The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.

For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

$sel:dualStackDnsName:Accelerator', accelerator_dualStackDnsName - 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.

The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.

Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

$sel:enabled:Accelerator', accelerator_enabled - Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

$sel:events:Accelerator', accelerator_events - A history of changes that you make to an accelerator in Global Accelerator.

$sel:ipAddressType:Accelerator', accelerator_ipAddressType - The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

$sel:ipSets:Accelerator', accelerator_ipSets - The static IP addresses that Global Accelerator associates with the accelerator.

$sel:lastModifiedTime:Accelerator', accelerator_lastModifiedTime - The date and time that the accelerator was last modified.

$sel:name:Accelerator', accelerator_name - The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

$sel:status:Accelerator', accelerator_status - Describes the deployment status of the accelerator.

accelerator_acceleratorArn :: Lens' Accelerator (Maybe Text) Source #

The Amazon Resource Name (ARN) of the accelerator.

accelerator_createdTime :: Lens' Accelerator (Maybe UTCTime) Source #

The date and time that the accelerator was created.

accelerator_dnsName :: Lens' Accelerator (Maybe Text) Source #

The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.

The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.

For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

accelerator_dualStackDnsName :: Lens' Accelerator (Maybe Text) Source #

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.

The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.

Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

accelerator_enabled :: Lens' Accelerator (Maybe Bool) Source #

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

accelerator_events :: Lens' Accelerator (Maybe [AcceleratorEvent]) Source #

A history of changes that you make to an accelerator in Global Accelerator.

accelerator_ipAddressType :: Lens' Accelerator (Maybe IpAddressType) Source #

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

accelerator_ipSets :: Lens' Accelerator (Maybe [IpSet]) Source #

The static IP addresses that Global Accelerator associates with the accelerator.

accelerator_lastModifiedTime :: Lens' Accelerator (Maybe UTCTime) Source #

The date and time that the accelerator was last modified.

accelerator_name :: Lens' Accelerator (Maybe Text) Source #

The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

accelerator_status :: Lens' Accelerator (Maybe AcceleratorStatus) Source #

Describes the deployment status of the accelerator.