Skip to content

Accelerator

Source code in docs_src/capo_global_accelerator/types/accelerator.py
class Accelerator(TypedDict, closed=True):
    accelerator_arn: NotRequired[
        "capo_global_accelerator.types.generic_string.GenericString"
    ]
    """<p>The Amazon Resource Name (ARN) of the accelerator.</p>"""
    name: NotRequired["capo_global_accelerator.types.generic_string.GenericString"]
    """<p>The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</p>"""
    ip_address_type: NotRequired[
        "capo_global_accelerator.types.ip_address_type.IpAddressType"
    ]
    """<p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>"""
    enabled: NotRequired["capo_global_accelerator.types.generic_boolean.GenericBoolean"]
    """<p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>"""
    ip_sets: NotRequired["capo_global_accelerator.types.ip_sets.IpSets"]
    """<p>The static IP addresses that Global Accelerator associates with the accelerator.</p>"""
    dns_name: NotRequired["capo_global_accelerator.types.generic_string.GenericString"]
    """<p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.</p> <p>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.</p> <p>If you have a dual-stack accelerator, you also have a second DNS name, <code>DualStackDnsName</code>, 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.</p> <p>For more information about the default DNS name, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html"> Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>"""
    status: NotRequired[
        "capo_global_accelerator.types.accelerator_status.AcceleratorStatus"
    ]
    """<p>Describes the deployment status of the accelerator.</p>"""
    created_time: NotRequired["capo_global_accelerator.types.timestamp.Timestamp"]
    """<p>The date and time that the accelerator was created.</p>"""
    last_modified_time: NotRequired["capo_global_accelerator.types.timestamp.Timestamp"]
    """<p>The date and time that the accelerator was last modified.</p>"""
    dual_stack_dns_name: NotRequired[
        "capo_global_accelerator.types.generic_string.GenericString"
    ]
    """<p>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.</p> <p>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.</p> <p>Note: Global Accelerator also assigns a default DNS name, <code>DnsName</code>, to your accelerator that points just to the static IPv4 addresses. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing"> Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>"""
    events: NotRequired[
        "capo_global_accelerator.types.accelerator_events.AcceleratorEvents"
    ]
    """<p>A history of changes that you make to an accelerator in Global Accelerator.</p>"""

accelerator_arn instance-attribute

accelerator_arn: NotRequired[GenericString]

The Amazon Resource Name (ARN) of the accelerator.

created_time instance-attribute

created_time: NotRequired[Timestamp]

The date and time that the accelerator was created.

dns_name instance-attribute

dns_name: NotRequired[GenericString]

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.

dual_stack_dns_name instance-attribute

dual_stack_dns_name: NotRequired[GenericString]

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 instance-attribute

enabled: NotRequired[GenericBoolean]

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 instance-attribute

events: NotRequired[AcceleratorEvents]

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

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

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

ip_sets instance-attribute

ip_sets: NotRequired[IpSets]

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

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The date and time that the accelerator was last modified.

name instance-attribute

name: NotRequired[GenericString]

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

status instance-attribute

status: NotRequired[AcceleratorStatus]

Describes the deployment status of the accelerator.