You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GlobalAccelerator::Types::Accelerator

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#accelerator_arnString

The Amazon Resource Name (ARN) of the accelerator.

Returns:

  • (String)


74
75
76
77
78
79
80
81
82
83
84
85
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 74

class Accelerator < Struct.new(
  :accelerator_arn,
  :name,
  :ip_address_type,
  :enabled,
  :ip_sets,
  :dns_name,
  :status,
  :created_time,
  :last_modified_time)
  include Aws::Structure
end

#created_timeTime

The date and time that the accelerator was created.

Returns:

  • (Time)


74
75
76
77
78
79
80
81
82
83
84
85
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 74

class Accelerator < Struct.new(
  :accelerator_arn,
  :name,
  :ip_address_type,
  :enabled,
  :ip_sets,
  :dns_name,
  :status,
  :created_time,
  :last_modified_time)
  include Aws::Structure
end

#dns_nameString

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

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

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

Returns:

  • (String)


74
75
76
77
78
79
80
81
82
83
84
85
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 74

class Accelerator < Struct.new(
  :accelerator_arn,
  :name,
  :ip_address_type,
  :enabled,
  :ip_sets,
  :dns_name,
  :status,
  :created_time,
  :last_modified_time)
  include Aws::Structure
end

#enabledBoolean

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.

Returns:

  • (Boolean)


74
75
76
77
78
79
80
81
82
83
84
85
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 74

class Accelerator < Struct.new(
  :accelerator_arn,
  :name,
  :ip_address_type,
  :enabled,
  :ip_sets,
  :dns_name,
  :status,
  :created_time,
  :last_modified_time)
  include Aws::Structure
end

#ip_address_typeString

The value for the address type must be IPv4.

Returns:

  • (String)


74
75
76
77
78
79
80
81
82
83
84
85
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 74

class Accelerator < Struct.new(
  :accelerator_arn,
  :name,
  :ip_address_type,
  :enabled,
  :ip_sets,
  :dns_name,
  :status,
  :created_time,
  :last_modified_time)
  include Aws::Structure
end

#ip_setsArray<Types::IpSet>

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

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 74

class Accelerator < Struct.new(
  :accelerator_arn,
  :name,
  :ip_address_type,
  :enabled,
  :ip_sets,
  :dns_name,
  :status,
  :created_time,
  :last_modified_time)
  include Aws::Structure
end

#last_modified_timeTime

The date and time that the accelerator was last modified.

Returns:

  • (Time)


74
75
76
77
78
79
80
81
82
83
84
85
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 74

class Accelerator < Struct.new(
  :accelerator_arn,
  :name,
  :ip_address_type,
  :enabled,
  :ip_sets,
  :dns_name,
  :status,
  :created_time,
  :last_modified_time)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


74
75
76
77
78
79
80
81
82
83
84
85
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 74

class Accelerator < Struct.new(
  :accelerator_arn,
  :name,
  :ip_address_type,
  :enabled,
  :ip_sets,
  :dns_name,
  :status,
  :created_time,
  :last_modified_time)
  include Aws::Structure
end

#statusString

Describes the deployment status of the accelerator.

Returns:

  • (String)


74
75
76
77
78
79
80
81
82
83
84
85
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 74

class Accelerator < Struct.new(
  :accelerator_arn,
  :name,
  :ip_address_type,
  :enabled,
  :ip_sets,
  :dns_name,
  :status,
  :created_time,
  :last_modified_time)
  include Aws::Structure
end