software.amazon.awscdk.services.ec2

Interface CfnIPAMProps

All Known Implementing Classes:

CfnIPAMProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:09.107Z")
public interface CfnIPAMProps

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()
         .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 and Description
static class	CfnIPAMProps.Builder A builder for CfnIPAMProps
static class	CfnIPAMProps.Jsii$Proxy An implementation for CfnIPAMProps

Method Summary

Modifier and Type	Method and Description
static CfnIPAMProps.Builder	builder()
default java.lang.String	getDescription() The description for the IPAM.
default java.lang.Object	getOperatingRegions() The operating Regions for an IPAM.
default java.util.List<CfnTag>	getTags() The key/value combination of a tag assigned to the resource.

Method Detail

getDescription

default java.lang.String getDescription()

The description for the IPAM.

getOperatingRegions

default java.lang.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

default java.util.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

static CfnIPAMProps.Builder builder()

Returns:

a CfnIPAMProps.Builder of CfnIPAMProps