Skip to content
v2.274.0

CfnIPAMScopeProps Struct ​

Properties for defining a CfnIPAMScope.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnIPAMScopeProps: ec2.CfnIPAMScopeProps = {
  ipamId: 'ipamId',

  // the properties below are optional
  description: 'description',
  externalAuthorityConfiguration: {
    externalResourceIdentifier: 'externalResourceIdentifier',
    ipamScopeExternalAuthorityType: 'ipamScopeExternalAuthorityType',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
The description of the scope.
externalAuthorityConfigurationIResolvable | CfnIPAMScope.IpamScopeExternalAuthorityConfigurationPropertyexternal_authority_configurationtyping.Union[IResolvable, IpamScopeExternalAuthorityConfigurationProperty]externalAuthorityConfigurationIResolvableExternalAuthorityConfigurationIResolvableExternalAuthorityConfigurationinterface{}#
The configuration that links an Amazon VPC IPAM scope to an external authority system.
notes

It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

For more information, see Integrate VPC IPAM with Infoblox infrastructure in the Amazon VPC IPAM User Guide .

ipamIdstringipam_idstripamIdStringIpamIdstringIpamId*stringrequired#
The ID of the IPAM for which you're creating this scope.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
The key/value combination of a tag assigned to the resource.
notes

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.