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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::IpamScope

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the scope.

• #external_authority_configuration ⇒ Types::IpamScopeExternalAuthorityConfiguration

  The external authority configuration for this IPAM scope, if configured.

• #ipam_arn ⇒ String

  The ARN of the IPAM.

• #ipam_region ⇒ String

  The Amazon Web Services Region of the IPAM scope.

• #ipam_scope_arn ⇒ String

  The Amazon Resource Name (ARN) of the scope.

• #ipam_scope_id ⇒ String

  The ID of the scope.

• #ipam_scope_type ⇒ String

  The type of the scope.

• #is_default ⇒ Boolean

  Defines if the scope is the default scope or not.

• #owner_id ⇒ String

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

• #pool_count ⇒ Integer

  The number of pools in the scope.

• #state ⇒ String

  The state of the IPAM scope.

• #tags ⇒ Array<Types::Tag>

  The key/value combination of a tag assigned to the resource.

Instance Attribute Details

#description ⇒ String

The description of the scope.

Returns:

• (String)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#external_authority_configuration ⇒ Types::IpamScopeExternalAuthorityConfiguration

The external authority configuration for this IPAM scope, if configured.

The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.

Returns:

• (Types::IpamScopeExternalAuthorityConfiguration)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_arn ⇒ String

The ARN of the IPAM.

Returns:

• (String)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_region ⇒ String

The Amazon Web Services Region of the IPAM scope.

Returns:

• (String)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_scope_arn ⇒ String

The Amazon Resource Name (ARN) of the scope.

Returns:

• (String)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_scope_id ⇒ String

The ID of the scope.

Returns:

• (String)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_scope_type ⇒ String

The type of the scope.

Returns:

• (String)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#is_default ⇒ Boolean

Defines if the scope is the default scope or not.

Returns:

• (Boolean)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

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

Returns:

• (String)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#pool_count ⇒ Integer

The number of pools in the scope.

Returns:

• (Integer)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the IPAM scope.

Returns:

• (String)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<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:

• (Array<Types::Tag>)

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

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,
  :external_authority_configuration)
  SENSITIVE = []
  include Aws::Structure
end