Skip to content

Modify Ipam Scope

ec2_modify_ipam_scope R Documentation

Modify an IPAM scope

Description

Modify an IPAM scope.

Usage

ec2_modify_ipam_scope(DryRun, IpamScopeId, Description,
  ExternalAuthorityConfiguration, RemoveExternalAuthorityConfiguration)

Arguments

DryRun

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.

IpamScopeId

[required] The ID of the scope you want to modify.

Description

The description of the scope you want to modify.

ExternalAuthorityConfiguration

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.

RemoveExternalAuthorityConfiguration

Remove the external authority configuration. true to remove.

Value

A list with the following syntax:

list(
  IpamScope = list(
    OwnerId = "string",
    IpamScopeId = "string",
    IpamScopeArn = "string",
    IpamArn = "string",
    IpamRegion = "string",
    IpamScopeType = "public"|"private",
    IsDefault = TRUE|FALSE,
    Description = "string",
    PoolCount = 123,
    State = "create-in-progress"|"create-complete"|"create-failed"|"modify-in-progress"|"modify-complete"|"modify-failed"|"delete-in-progress"|"delete-complete"|"delete-failed"|"isolate-in-progress"|"isolate-complete"|"restore-in-progress",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    ExternalAuthorityConfiguration = list(
      Type = "infoblox",
      ExternalResourceIdentifier = "string"
    )
  )
)

Request syntax

svc$modify_ipam_scope(
  DryRun = TRUE|FALSE,
  IpamScopeId = "string",
  Description = "string",
  ExternalAuthorityConfiguration = list(
    Type = "infoblox",
    ExternalResourceIdentifier = "string"
  ),
  RemoveExternalAuthorityConfiguration = TRUE|FALSE
)