Package software.amazon.awscdk.services.ec2

Interface CfnIPAMProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIPAMProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:38.603Z")
@Stability(Stable)
public interface CfnIPAMProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIPAM.

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.*;
 CfnIPAMProps cfnIPAMProps = CfnIPAMProps.builder()
         .defaultResourceDiscoveryAssociationId("defaultResourceDiscoveryAssociationId")
         .defaultResourceDiscoveryId("defaultResourceDiscoveryId")
         .description("description")
         .operatingRegions(List.of(IpamOperatingRegionProperty.builder()
                 .regionName("regionName")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIPAMProps.Builder	builder()
default String	getDefaultResourceDiscoveryAssociationId()	The IPAM's default resource discovery association ID.
default String	getDefaultResourceDiscoveryId()	The IPAM's default resource discovery ID.
default String	getDescription()	The description for the IPAM.
default Object	getOperatingRegions()	The operating Regions for an IPAM.
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

getDefaultResourceDiscoveryAssociationId

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

The IPAM's default resource discovery association ID.

getDefaultResourceDiscoveryId

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

The IPAM's default resource discovery ID.

getDescription

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

The description for the IPAM.

getOperatingRegions

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

The operating Regions for an IPAM.

Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .

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.

builder

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

Returns:

a CfnIPAMProps.Builder of CfnIPAMProps