Class: Aws::EC2::Types::ProvisionByoipCidrRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ProvisionByoipCidrRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cidr ⇒ String

  The public IPv4 or IPv6 address range, in CIDR notation.

• #cidr_authorization_context ⇒ Types::CidrAuthorizationContext

  A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

• #description ⇒ String

  A description for the address range and the address pool.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #multi_region ⇒ Boolean

  Reserved.

• #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.

• #pool_tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to apply to the address pool.

• #publicly_advertisable ⇒ Boolean

  (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

Instance Attribute Details

#cidr ⇒ String

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you’ve brought to this or another Region.

Returns:

• (String)

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

class ProvisionByoipCidrRequest < Struct.new(
  :cidr,
  :cidr_authorization_context,
  :publicly_advertisable,
  :description,
  :dry_run,
  :pool_tag_specifications,
  :multi_region,
  :network_border_group)
  SENSITIVE = []
  include Aws::Structure
end

#cidr_authorization_context ⇒ Types::CidrAuthorizationContext

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

Returns:

• (Types::CidrAuthorizationContext)

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

class ProvisionByoipCidrRequest < Struct.new(
  :cidr,
  :cidr_authorization_context,
  :publicly_advertisable,
  :description,
  :dry_run,
  :pool_tag_specifications,
  :multi_region,
  :network_border_group)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the address range and the address pool.

Returns:

• (String)

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

class ProvisionByoipCidrRequest < Struct.new(
  :cidr,
  :cidr_authorization_context,
  :publicly_advertisable,
  :description,
  :dry_run,
  :pool_tag_specifications,
  :multi_region,
  :network_border_group)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

• (Boolean)

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

class ProvisionByoipCidrRequest < Struct.new(
  :cidr,
  :cidr_authorization_context,
  :publicly_advertisable,
  :description,
  :dry_run,
  :pool_tag_specifications,
  :multi_region,
  :network_border_group)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region ⇒ Boolean

Reserved.

Returns:

• (Boolean)

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

class ProvisionByoipCidrRequest < Struct.new(
  :cidr,
  :cidr_authorization_context,
  :publicly_advertisable,
  :description,
  :dry_run,
  :pool_tag_specifications,
  :multi_region,
  :network_border_group)
  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

<note markdown=“1”> You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

</note>

[1]: docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html

Returns:

• (String)

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

class ProvisionByoipCidrRequest < Struct.new(
  :cidr,
  :cidr_authorization_context,
  :publicly_advertisable,
  :description,
  :dry_run,
  :pool_tag_specifications,
  :multi_region,
  :network_border_group)
  SENSITIVE = []
  include Aws::Structure
end

#pool_tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the address pool.

Returns:

• (Array<Types::TagSpecification>)

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

class ProvisionByoipCidrRequest < Struct.new(
  :cidr,
  :cidr_authorization_context,
  :publicly_advertisable,
  :description,
  :dry_run,
  :pool_tag_specifications,
  :multi_region,
  :network_border_group)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_advertisable ⇒ Boolean

(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

Default: true

Returns:

• (Boolean)

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

class ProvisionByoipCidrRequest < Struct.new(
  :cidr,
  :cidr_authorization_context,
  :publicly_advertisable,
  :description,
  :dry_run,
  :pool_tag_specifications,
  :multi_region,
  :network_border_group)
  SENSITIVE = []
  include Aws::Structure
end