Class: Aws::EC2::Types::CreateIpamRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateIpamRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #description ⇒ String

  A description for the IPAM.

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

• #metered_account ⇒ String

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

• #operating_regions ⇒ Array<Types::AddIpamOperatingRegion>

  The operating Regions for the IPAM.

• #tag_specifications ⇒ Array<Types::TagSpecification>

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

• #tier ⇒ String

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

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

• (String)

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

class CreateIpamRequest < Struct.new(
  :dry_run,
  :description,
  :operating_regions,
  :tag_specifications,
  :client_token,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the IPAM.

Returns:

• (String)

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

class CreateIpamRequest < Struct.new(
  :dry_run,
  :description,
  :operating_regions,
  :tag_specifications,
  :client_token,
  :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 9937

class CreateIpamRequest < Struct.new(
  :dry_run,
  :description,
  :operating_regions,
  :tag_specifications,
  :client_token,
  :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 9937

class CreateIpamRequest < Struct.new(
  :dry_run,
  :description,
  :operating_regions,
  :tag_specifications,
  :client_token,
  :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 9937

class CreateIpamRequest < Struct.new(
  :dry_run,
  :description,
  :operating_regions,
  :tag_specifications,
  :client_token,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end

#operating_regions ⇒ Array<Types::AddIpamOperatingRegion>

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 9937

class CreateIpamRequest < Struct.new(
  :dry_run,
  :description,
  :operating_regions,
  :tag_specifications,
  :client_token,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

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::TagSpecification>)

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

class CreateIpamRequest < Struct.new(
  :dry_run,
  :description,
  :operating_regions,
  :tag_specifications,
  :client_token,
  :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 9937

class CreateIpamRequest < Struct.new(
  :dry_run,
  :description,
  :operating_regions,
  :tag_specifications,
  :client_token,
  :tier,
  :enable_private_gua,
  :metered_account)
  SENSITIVE = []
  include Aws::Structure
end