Class: Aws::EC2::Types::IpamResourceCidr

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::IpamResourceCidr

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

The CIDR for an IPAM resource.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #availability_zone_id ⇒ String

  The Availability Zone ID.

• #compliance_status ⇒ String

  The compliance status of the IPAM resource.

• #ip_usage ⇒ Float

  The percentage of IP address space in use.

• #ipam_id ⇒ String

  The IPAM ID for an IPAM resource.

• #ipam_pool_id ⇒ String

  The pool ID for an IPAM resource.

• #ipam_scope_id ⇒ String

  The scope ID for an IPAM resource.

• #management_state ⇒ String

  The management state of the resource.

• #overlap_status ⇒ String

  The overlap status of an IPAM resource.

• #resource_cidr ⇒ String

  The CIDR for an IPAM resource.

• #resource_id ⇒ String

  The ID of an IPAM resource.

• #resource_name ⇒ String

  The name of an IPAM resource.

• #resource_owner_id ⇒ String

  The Amazon Web Services account number of the owner of an IPAM resource.

• #resource_region ⇒ String

  The Amazon Web Services Region for an IPAM resource.

• #resource_tags ⇒ Array<Types::IpamResourceTag>

  The tags for an IPAM resource.

• #resource_type ⇒ String

  The type of IPAM resource.

• #vpc_id ⇒ String

  The ID of a VPC.

Instance Attribute Details

#availability_zone_id ⇒ String

The Availability Zone ID.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_status ⇒ String

The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#ip_usage ⇒ Float

The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

• For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.

• For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.

• For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).

Returns:

• (Float)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_id ⇒ String

The IPAM ID for an IPAM resource.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_pool_id ⇒ String

The pool ID for an IPAM resource.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_scope_id ⇒ String

The scope ID for an IPAM resource.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#management_state ⇒ String

The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#overlap_status ⇒ String

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_cidr ⇒ String

The CIDR for an IPAM resource.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id ⇒ String

The ID of an IPAM resource.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_name ⇒ String

The name of an IPAM resource.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_owner_id ⇒ String

The Amazon Web Services account number of the owner of an IPAM resource.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_region ⇒ String

The Amazon Web Services Region for an IPAM resource.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_tags ⇒ Array<Types::IpamResourceTag>

The tags for an IPAM resource.

Returns:

• (Array<Types::IpamResourceTag>)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of IPAM resource.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The ID of a VPC.

Returns:

• (String)

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

class IpamResourceCidr < Struct.new(
  :ipam_id,
  :ipam_scope_id,
  :ipam_pool_id,
  :resource_region,
  :resource_owner_id,
  :resource_id,
  :resource_name,
  :resource_cidr,
  :resource_type,
  :resource_tags,
  :ip_usage,
  :compliance_status,
  :management_state,
  :overlap_status,
  :vpc_id,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end