Class: Aws::EC2::Types::ByoipCidr

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ByoipCidr

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #advertisement_type ⇒ String

  Specifies the advertisement method for the BYOIP CIDR.

• #asn_associations ⇒ Array<Types::AsnAssociation>

  The BYOIP CIDR associations with ASNs.

• #cidr ⇒ String

  The address range, in CIDR notation.

• #description ⇒ String

  The description of the address range.

• #network_border_group ⇒ String

  If you have [Local Zones][1] enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR.

• #state ⇒ String

  The state of the address range.

• #status_message ⇒ String

  Upon success, contains the ID of the address pool.

Instance Attribute Details

#advertisement_type ⇒ String

Specifies the advertisement method for the BYOIP CIDR. Valid values are:

• unicast: IP is advertised from a single location (regional services like EC2)

• anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)

For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4448

class ByoipCidr < Struct.new(
  :cidr,
  :description,
  :asn_associations,
  :status_message,
  :state,
  :network_border_group,
  :advertisement_type)
  SENSITIVE = []
  include Aws::Structure
end

#asn_associations ⇒ Array<Types::AsnAssociation>

The BYOIP CIDR associations with ASNs.

Returns:

• (Array<Types::AsnAssociation>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4448

class ByoipCidr < Struct.new(
  :cidr,
  :description,
  :asn_associations,
  :status_message,
  :state,
  :network_border_group,
  :advertisement_type)
  SENSITIVE = []
  include Aws::Structure
end

#cidr ⇒ String

The address range, in CIDR notation.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4448

class ByoipCidr < Struct.new(
  :cidr,
  :description,
  :asn_associations,
  :status_message,
  :state,
  :network_border_group,
  :advertisement_type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the address range.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4448

class ByoipCidr < Struct.new(
  :cidr,
  :description,
  :asn_associations,
  :status_message,
  :state,
  :network_border_group,
  :advertisement_type)
  SENSITIVE = []
  include Aws::Structure
end

#network_border_group ⇒ String

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

• us-east-1-dfw-2

• us-west-2-lax-1

• us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4448

class ByoipCidr < Struct.new(
  :cidr,
  :description,
  :asn_associations,
  :status_message,
  :state,
  :network_border_group,
  :advertisement_type)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the address range.

• advertised: The address range is being advertised to the internet by Amazon Web Services.

• deprovisioned: The address range is deprovisioned.

• failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

• failed-provision: The request to provision the address range was unsuccessful.

• pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.

• pending-provision: You’ve submitted a request to provision an address range and it's pending.

• provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

• provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4448

class ByoipCidr < Struct.new(
  :cidr,
  :description,
  :asn_associations,
  :status_message,
  :state,
  :network_border_group,
  :advertisement_type)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4448

class ByoipCidr < Struct.new(
  :cidr,
  :description,
  :asn_associations,
  :status_message,
  :state,
  :network_border_group,
  :advertisement_type)
  SENSITIVE = []
  include Aws::Structure
end