Class: Aws::EC2::Types::IpamResourceDiscovery

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::IpamResourceDiscovery

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The resource discovery description.

• #ipam_resource_discovery_arn ⇒ String

  The resource discovery Amazon Resource Name (ARN).

• #ipam_resource_discovery_id ⇒ String

  The resource discovery ID.

• #ipam_resource_discovery_region ⇒ String

  The resource discovery Region.

• #is_default ⇒ Boolean

  Defines if the resource discovery is the default.

• #operating_regions ⇒ Array<Types::IpamOperatingRegion>

  The operating Regions for the resource discovery.

• #organizational_unit_exclusions ⇒ Array<Types::IpamOrganizationalUnitExclusion>

  If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.

• #owner_id ⇒ String

  The ID of the owner.

• #state ⇒ String

  The lifecycle state of the resource discovery.

• #tags ⇒ Array<Types::Tag>

  A tag is a label that you assign to an Amazon Web Services resource.

Instance Attribute Details

#description ⇒ String

The resource discovery description.

Returns:

• (String)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_resource_discovery_arn ⇒ String

The resource discovery Amazon Resource Name (ARN).

Returns:

• (String)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_resource_discovery_id ⇒ String

The resource discovery ID.

Returns:

• (String)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_resource_discovery_region ⇒ String

The resource discovery Region.

Returns:

• (String)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#is_default ⇒ Boolean

Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.

Returns:

• (Boolean)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#operating_regions ⇒ Array<Types::IpamOperatingRegion>

The operating Regions for the resource discovery. 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.

Returns:

• (Array<Types::IpamOperatingRegion>)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#organizational_unit_exclusions ⇒ Array<Types::IpamOrganizationalUnitExclusion>

If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.

Returns:

• (Array<Types::IpamOrganizationalUnitExclusion>)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

The ID of the owner.

Returns:

• (String)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The lifecycle state of the resource discovery.

• create-in-progress - Resource discovery is being created.

• create-complete - Resource discovery creation is complete.

• create-failed - Resource discovery creation has failed.

• modify-in-progress - Resource discovery is being modified.

• modify-complete - Resource discovery modification is complete.

• modify-failed - Resource discovery modification has failed.

• delete-in-progress - Resource discovery is being deleted.

• delete-complete - Resource discovery deletion is complete.

• delete-failed - Resource discovery deletion has failed.

• isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.

• isolate-complete - Resource discovery isolation is complete.

• restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.

Returns:

• (String)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

Returns:

• (Array<Types::Tag>)

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

class IpamResourceDiscovery < Struct.new(
  :owner_id,
  :ipam_resource_discovery_id,
  :ipam_resource_discovery_arn,
  :ipam_resource_discovery_region,
  :description,
  :operating_regions,
  :is_default,
  :state,
  :tags,
  :organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end