Class: Aws::EC2::Types::Ipam

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

Overview

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_resource_discovery_association_idString

The IPAM's default resource discovery association ID.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#default_resource_discovery_idString

The IPAM's default resource discovery ID.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description for the IPAM.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_arnString

The Amazon Resource Name (ARN) of the IPAM.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_idString

The ID of the IPAM.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_regionString

The Amazon Web Services Region of the IPAM.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#operating_regionsArray<Types::IpamOperatingRegion>

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

Returns:



42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#owner_idString

The Amazon Web Services account ID of the owner of the IPAM.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#private_default_scope_idString

The ID of the IPAM's default private scope.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#public_default_scope_idString

The ID of the IPAM's default public scope.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#resource_discovery_association_countInteger

The IPAM's resource discovery association count.

Returns:

  • (Integer)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#scope_countInteger

The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

Returns:

  • (Integer)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The state of the IPAM.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#state_messageString

The state message.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Returns:



42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end

#tierString

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

Returns:

  • (String)


42017
42018
42019
42020
42021
42022
42023
42024
42025
42026
42027
42028
42029
42030
42031
42032
42033
42034
42035
42036
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42017

class Ipam < Struct.new(
  :owner_id,
  :ipam_id,
  :ipam_arn,
  :ipam_region,
  :public_default_scope_id,
  :private_default_scope_id,
  :scope_count,
  :description,
  :operating_regions,
  :state,
  :tags,
  :default_resource_discovery_id,
  :default_resource_discovery_association_id,
  :resource_discovery_association_count,
  :state_message,
  :tier)
  SENSITIVE = []
  include Aws::Structure
end