Class: Aws::EC2::Types::AllocateIpamPoolCidrRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::AllocateIpamPoolCidrRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_cidrs ⇒ Array<String>

  Include a particular CIDR range that can be returned by the pool.

• #cidr ⇒ String

  The CIDR you would like to allocate from the IPAM pool.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #description ⇒ String

  A description for the allocation.

• #disallowed_cidrs ⇒ Array<String>

  Exclude a particular CIDR range from being returned by the pool.

• #dry_run ⇒ Boolean

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

• #ipam_pool_id ⇒ String

  The ID of the IPAM pool from which you would like to allocate a CIDR.

• #netmask_length ⇒ Integer

  The netmask length of the CIDR you would like to allocate from the IPAM pool.

• #preview_next_cidr ⇒ Boolean

  A preview of the next available CIDR in a pool.

Instance Attribute Details

#allowed_cidrs ⇒ Array<String>

Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.

Returns:

• (Array<String>)

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

class AllocateIpamPoolCidrRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :cidr,
  :netmask_length,
  :client_token,
  :description,
  :preview_next_cidr,
  :allowed_cidrs,
  :disallowed_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#cidr ⇒ String

The CIDR you would like to allocate from the IPAM pool. Note the following:

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible values: Any available IPv4 or IPv6 CIDR.

Returns:

• (String)

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

class AllocateIpamPoolCidrRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :cidr,
  :netmask_length,
  :client_token,
  :description,
  :preview_next_cidr,
  :allowed_cidrs,
  :disallowed_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

• (String)

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

class AllocateIpamPoolCidrRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :cidr,
  :netmask_length,
  :client_token,
  :description,
  :preview_next_cidr,
  :allowed_cidrs,
  :disallowed_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the allocation.

Returns:

• (String)

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

class AllocateIpamPoolCidrRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :cidr,
  :netmask_length,
  :client_token,
  :description,
  :preview_next_cidr,
  :allowed_cidrs,
  :disallowed_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#disallowed_cidrs ⇒ Array<String>

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

Returns:

• (Array<String>)

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

class AllocateIpamPoolCidrRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :cidr,
  :netmask_length,
  :client_token,
  :description,
  :preview_next_cidr,
  :allowed_cidrs,
  :disallowed_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

A check for 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 1188

class AllocateIpamPoolCidrRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :cidr,
  :netmask_length,
  :client_token,
  :description,
  :preview_next_cidr,
  :allowed_cidrs,
  :disallowed_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_pool_id ⇒ String

The ID of the IPAM pool from which you would like to allocate a CIDR.

Returns:

• (String)

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

class AllocateIpamPoolCidrRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :cidr,
  :netmask_length,
  :client_token,
  :description,
  :preview_next_cidr,
  :allowed_cidrs,
  :disallowed_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#netmask_length ⇒ Integer

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Returns:

• (Integer)

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

class AllocateIpamPoolCidrRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :cidr,
  :netmask_length,
  :client_token,
  :description,
  :preview_next_cidr,
  :allowed_cidrs,
  :disallowed_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#preview_next_cidr ⇒ Boolean

A preview of the next available CIDR in a pool.

Returns:

• (Boolean)

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

class AllocateIpamPoolCidrRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :cidr,
  :netmask_length,
  :client_token,
  :description,
  :preview_next_cidr,
  :allowed_cidrs,
  :disallowed_cidrs)
  SENSITIVE = []
  include Aws::Structure
end