Class: Aws::EC2::Types::IpamScope

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

Overview

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see How IPAM works in the Amazon VPC IPAM User Guide.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the scope.

Returns:

  • (String)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_arnString

The ARN of the IPAM.

Returns:

  • (String)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_regionString

The Amazon Web Services Region of the IPAM scope.

Returns:

  • (String)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_scope_arnString

The Amazon Resource Name (ARN) of the scope.

Returns:

  • (String)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_scope_idString

The ID of the scope.

Returns:

  • (String)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_scope_typeString

The type of the scope.

Returns:

  • (String)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#is_defaultBoolean

Defines if the scope is the default scope or not.

Returns:

  • (Boolean)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#owner_idString

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

Returns:

  • (String)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pool_countInteger

The number of pools in the scope.

Returns:

  • (Integer)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The state of the IPAM scope.

Returns:

  • (String)


39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  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:



39902
39903
39904
39905
39906
39907
39908
39909
39910
39911
39912
39913
39914
39915
39916
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39902

class IpamScope < Struct.new(
  :owner_id,
  :ipam_scope_id,
  :ipam_scope_arn,
  :ipam_arn,
  :ipam_region,
  :ipam_scope_type,
  :is_default,
  :description,
  :pool_count,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end