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

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

Overview

Note:

When making an API call, you may pass ProvisionByoipCidrRequest data as a 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: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-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, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  multi_region: false,
}

Constant Summary collapse

SENSITIVE =
[]

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)


53183
53184
53185
53186
53187
53188
53189
53190
53191
53192
53193
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53183

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

#cidr_authorization_contextTypes::CidrAuthorizationContext

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



53183
53184
53185
53186
53187
53188
53189
53190
53191
53192
53193
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53183

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

#descriptionString

A description for the address range and the address pool.

Returns:

  • (String)


53183
53184
53185
53186
53187
53188
53189
53190
53191
53192
53193
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53183

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

#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)


53183
53184
53185
53186
53187
53188
53189
53190
53191
53192
53193
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53183

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

#multi_regionBoolean

Reserved.

Returns:

  • (Boolean)


53183
53184
53185
53186
53187
53188
53189
53190
53191
53192
53193
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53183

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

#pool_tag_specificationsArray<Types::TagSpecification>

The tags to apply to the address pool.

Returns:



53183
53184
53185
53186
53187
53188
53189
53190
53191
53192
53193
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53183

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

#publicly_advertisableBoolean

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

Default: true

Returns:

  • (Boolean)


53183
53184
53185
53186
53187
53188
53189
53190
53191
53192
53193
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53183

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