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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ProvisionByoipCidrRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  cidr: "String", # required
  cidr_authorization_context: {
    message: "String", # required
    signature: "String", # required
  },
  publicly_advertisable: false,
  description: "String",
  dry_run: false,
  pool_tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#cidrString

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 prefix you can specify is /56. The address range cannot overlap with another address range that you\'ve brought to this or another Region.

Returns:

  • (String)

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

#cidr_authorization_contextTypes::CidrAuthorizationContext

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

Returns:

  • (Types::CidrAuthorizationContext)

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

#descriptionString

A description for the address range and the address pool.

Returns:

  • (String)

    A description for the address range and the address pool.

#dry_runBoolean

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)

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

#pool_tag_specificationsArray<Types::TagSpecification>

The tags to apply to the address pool.

Returns:

#publicly_advertisableBoolean

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

Default: true

Returns:

  • (Boolean)

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