Package software.amazon.awscdk.services.ec2

Interface CfnIPAMScopeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIPAMScopeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:18.795Z")
@Stability(Stable)
public interface CfnIPAMScopeProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIPAMScope.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnIPAMScopeProps cfnIPAMScopeProps = CfnIPAMScopeProps.builder()
         .ipamId("ipamId")
         // the properties below are optional
         .description("description")
         .externalAuthorityConfiguration(IpamScopeExternalAuthorityConfigurationProperty.builder()
                 .externalResourceIdentifier("externalResourceIdentifier")
                 .ipamScopeExternalAuthorityType("ipamScopeExternalAuthorityType")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIPAMScopeProps.Builder	A builder for CfnIPAMScopeProps
static final class	CfnIPAMScopeProps.Jsii$Proxy	An implementation for CfnIPAMScopeProps

Method Summary

Modifier and Type	Method	Description
static CfnIPAMScopeProps.Builder	builder()
default String	getDescription()	The description of the scope.
default Object	getExternalAuthorityConfiguration()	The configuration that links an Amazon VPC IPAM scope to an external authority system.
String	getIpamId()	The ID of the IPAM for which you're creating this scope.
default List<CfnTag>	getTags()	The key/value combination of a tag assigned to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIpamId

@Stability(Stable)
@NotNull
String getIpamId()

The ID of the IPAM for which you're creating this scope.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-ipamid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the scope.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-description

getExternalAuthorityConfiguration

@Stability(Stable)
@Nullable
default Object getExternalAuthorityConfiguration()

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.

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

Returns union: either IResolvable or CfnIPAMScope.IpamScopeExternalAuthorityConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-externalauthorityconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-tags

builder

@Stability(Stable)
static CfnIPAMScopeProps.Builder builder()

Returns:

a CfnIPAMScopeProps.Builder of CfnIPAMScopeProps