Package software.amazon.awscdk.services.ec2

Class CfnIPAMResourceDiscovery

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnIPAMResourceDiscovery
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:41.910Z") @Stability(Stable) public class CfnIPAMResourceDiscovery extends CfnResource implements IInspectable, ITaggable
A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

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.*;
 CfnIPAMResourceDiscovery cfnIPAMResourceDiscovery = CfnIPAMResourceDiscovery.Builder.create(this, "MyCfnIPAMResourceDiscovery")
         .description("description")
         .operatingRegions(List.of(IpamOperatingRegionProperty.builder()
                 .regionName("regionName")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIPAMResourceDiscovery

      protected CfnIPAMResourceDiscovery(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIPAMResourceDiscovery

      protected CfnIPAMResourceDiscovery(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIPAMResourceDiscovery

      @Stability(Stable) public CfnIPAMResourceDiscovery(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnIPAMResourceDiscoveryProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnIPAMResourceDiscovery

      @Stability(Stable) public CfnIPAMResourceDiscovery(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrIpamResourceDiscoveryArn

      @Stability(Stable) @NotNull public String getAttrIpamResourceDiscoveryArn()
      The resource discovery ARN.

    • getAttrIpamResourceDiscoveryId

      @Stability(Stable) @NotNull public String getAttrIpamResourceDiscoveryId()
      The resource discovery ID.

    • getAttrIpamResourceDiscoveryRegion

      @Stability(Stable) @NotNull public String getAttrIpamResourceDiscoveryRegion()
      The resource discovery Region.

    • getAttrIsDefault

      @Stability(Stable) @NotNull public IResolvable getAttrIsDefault()
      Defines if the resource discovery is the default.

      The default resource discovery is the resource discovery automatically created when you create an IPAM.

    • getAttrOwnerId

      @Stability(Stable) @NotNull public String getAttrOwnerId()
      The owner ID.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The resource discovery's state.

      • create-in-progress - Resource discovery is being created.
      • create-complete - Resource discovery creation is complete.
      • create-failed - Resource discovery creation has failed.
      • modify-in-progress - Resource discovery is being modified.
      • modify-complete - Resource discovery modification is complete.
      • modify-failed - Resource discovery modification has failed.
      • delete-in-progress - Resource discovery is being deleted.
      • delete-complete - Resource discovery deletion is complete.
      • delete-failed - Resource discovery deletion has failed.
      • isolate-in-progress - AWS account that created the resource discovery has been removed and the resource discovery is being isolated.
      • isolate-complete - Resource discovery isolation is complete.
      • restore-in-progress - AWS account that created the resource discovery and was isolated has been restored.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The resource discovery description.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The resource discovery description.

    • getOperatingRegions

      @Stability(Stable) @Nullable public Object getOperatingRegions()
      The operating Regions for the resource discovery.

    • setOperatingRegions

      @Stability(Stable) public void setOperatingRegions(@Nullable IResolvable value)
      The operating Regions for the resource discovery.

    • setOperatingRegions

      @Stability(Stable) public void setOperatingRegions(@Nullable List<Object> value)
      The operating Regions for the resource discovery.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A tag is a label that you assign to an AWS resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A tag is a label that you assign to an AWS resource.