Class: Aws::EC2::Types::ModifyIpamResourceDiscoveryRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyIpamResourceDiscoveryRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #add_operating_regions ⇒ Array<Types::AddIpamOperatingRegion>

  Add operating Regions to the resource discovery.

• #add_organizational_unit_exclusions ⇒ Array<Types::AddIpamOrganizationalUnitExclusion>

  Add an Organizational Unit (OU) exclusion to your IPAM.

• #description ⇒ String

  A resource discovery description.

• #dry_run ⇒ Boolean

  A check for whether you have the required permissions for the action without actually making the request and provides an error response.

• #ipam_resource_discovery_id ⇒ String

  A resource discovery ID.

• #remove_operating_regions ⇒ Array<Types::RemoveIpamOperatingRegion>

  Remove operating Regions.

• #remove_organizational_unit_exclusions ⇒ Array<Types::RemoveIpamOrganizationalUnitExclusion>

  Remove an Organizational Unit (OU) exclusion to your IPAM.

Instance Attribute Details

#add_operating_regions ⇒ Array<Types::AddIpamOperatingRegion>

Add operating Regions to 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::AddIpamOperatingRegion>)

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

class ModifyIpamResourceDiscoveryRequest < Struct.new(
  :dry_run,
  :ipam_resource_discovery_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :add_organizational_unit_exclusions,
  :remove_organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#add_organizational_unit_exclusions ⇒ Array<Types::AddIpamOrganizationalUnitExclusion>

Add an Organizational Unit (OU) exclusion to your IPAM. 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. There is a limit on the number of exclusions you can create. For more information, see

Quotas for your IPAM][1

in the *Amazon VPC IPAM User Guide*.

<note markdown=“1”> The resulting set of exclusions must not result in “overlap”, meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in [Add or remove OU exclusions ][2] in the *Amazon VPC User Guide*.

</note>

[1]: docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html [2]: docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html#exclude-ous-create-delete

Returns:

• (Array<Types::AddIpamOrganizationalUnitExclusion>)

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

class ModifyIpamResourceDiscoveryRequest < Struct.new(
  :dry_run,
  :ipam_resource_discovery_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :add_organizational_unit_exclusions,
  :remove_organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A resource discovery description.

Returns:

• (String)

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

class ModifyIpamResourceDiscoveryRequest < Struct.new(
  :dry_run,
  :ipam_resource_discovery_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :add_organizational_unit_exclusions,
  :remove_organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

• (Boolean)

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

class ModifyIpamResourceDiscoveryRequest < Struct.new(
  :dry_run,
  :ipam_resource_discovery_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :add_organizational_unit_exclusions,
  :remove_organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_resource_discovery_id ⇒ String

A resource discovery ID.

Returns:

• (String)

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

class ModifyIpamResourceDiscoveryRequest < Struct.new(
  :dry_run,
  :ipam_resource_discovery_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :add_organizational_unit_exclusions,
  :remove_organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#remove_operating_regions ⇒ Array<Types::RemoveIpamOperatingRegion>

Remove operating Regions.

Returns:

• (Array<Types::RemoveIpamOperatingRegion>)

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

class ModifyIpamResourceDiscoveryRequest < Struct.new(
  :dry_run,
  :ipam_resource_discovery_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :add_organizational_unit_exclusions,
  :remove_organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end

#remove_organizational_unit_exclusions ⇒ Array<Types::RemoveIpamOrganizationalUnitExclusion>

Remove an Organizational Unit (OU) exclusion to your IPAM. 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. There is a limit on the number of exclusions you can create. For more information, see

Quotas for your IPAM][1

in the *Amazon VPC IPAM User Guide*.

<note markdown=“1”> The resulting set of exclusions must not result in “overlap”, meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in [Add or remove OU exclusions ][2] in the *Amazon VPC User Guide*.

</note>

[1]: docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html [2]: docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html#exclude-ous-create-delete

Returns:

• (Array<Types::RemoveIpamOrganizationalUnitExclusion>)

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

class ModifyIpamResourceDiscoveryRequest < Struct.new(
  :dry_run,
  :ipam_resource_discovery_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :add_organizational_unit_exclusions,
  :remove_organizational_unit_exclusions)
  SENSITIVE = []
  include Aws::Structure
end