Class: Aws::EC2::Types::ModifyIpamRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyIpamRequest

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>

  Choose the operating Regions for the IPAM.

• #description ⇒ String

  The description of the IPAM you want to modify.

• #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.

• #enable_private_gua ⇒ Boolean

  Enable this option to use your own GUA ranges as private IPv6 addresses.

• #ipam_id ⇒ String

  The ID of the IPAM you want to modify.

• #metered_account ⇒ String

  A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM.

• #remove_operating_regions ⇒ Array<Types::RemoveIpamOperatingRegion>

  The operating Regions to remove.

• #tier ⇒ String

  IPAM is offered in a Free Tier and an Advanced Tier.

Instance Attribute Details

#add_operating_regions ⇒ Array<Types::AddIpamOperatingRegion>

Choose the operating Regions for the 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*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html

Returns:

• (Array<Types::AddIpamOperatingRegion>)

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

class ModifyIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the IPAM you want to modify.

Returns:

• (String)

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

class ModifyIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :tier,
  :enable_private_gua,
  :metered_account)
  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 54097

class ModifyIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end

#enable_private_gua ⇒ Boolean

Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Returns:

• (Boolean)

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

class ModifyIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_id ⇒ String

The ID of the IPAM you want to modify.

Returns:

• (String)

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

class ModifyIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end

#metered_account ⇒ String

A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see

Enable cost distribution][1

in the *Amazon VPC IPAM User Guide*.

Possible values:

• ‘ipam-owner` (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.

• ‘resource-owner`: The Amazon Web Services account that owns the IP address is charged for the active IP address.

[1]: docs.aws.amazon.com/vpc/latest/ipam/ipam-enable-cost-distro.html

Returns:

• (String)

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

class ModifyIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end

#remove_operating_regions ⇒ Array<Types::RemoveIpamOperatingRegion>

The operating Regions to remove.

Returns:

• (Array<Types::RemoveIpamOperatingRegion>)

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

class ModifyIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end

#tier ⇒ String

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 &gt; IPAM tab].

[1]: aws.amazon.com/vpc/pricing/

Returns:

• (String)

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

class ModifyIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :add_operating_regions,
  :remove_operating_regions,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end