Package software.amazon.awscdk.services.ec2

Class CfnIPAMResourceDiscoveryAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ec2.CfnIPAMResourceDiscoveryAssociation
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.607Z") @Stability(Stable) public class CfnIPAMResourceDiscoveryAssociation extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::IPAMResourceDiscoveryAssociation.

An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.

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.*;
 CfnIPAMResourceDiscoveryAssociation cfnIPAMResourceDiscoveryAssociation = CfnIPAMResourceDiscoveryAssociation.Builder.create(this, "MyCfnIPAMResourceDiscoveryAssociation")
         .ipamId("ipamId")
         .ipamResourceDiscoveryId("ipamResourceDiscoveryId")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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

    • CfnIPAMResourceDiscoveryAssociation

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

    • CfnIPAMResourceDiscoveryAssociation

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

    • CfnIPAMResourceDiscoveryAssociation

      @Stability(Stable) public CfnIPAMResourceDiscoveryAssociation(@NotNull Construct scope, @NotNull String id, @NotNull CfnIPAMResourceDiscoveryAssociationProps props)
      Create a new AWS::EC2::IPAMResourceDiscoveryAssociation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      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.

    • getAttrIpamArn

      @Stability(Stable) @NotNull public String getAttrIpamArn()
      The IPAM ARN.

    • getAttrIpamRegion

      @Stability(Stable) @NotNull public String getAttrIpamRegion()
      The IPAM home Region.

    • getAttrIpamResourceDiscoveryAssociationArn

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

    • getAttrIpamResourceDiscoveryAssociationId

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

    • getAttrIsDefault

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

      When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.

    • getAttrOwnerId

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

    • getAttrResourceDiscoveryStatus

      @Stability(Stable) @NotNull public String getAttrResourceDiscoveryStatus()
      The resource discovery status.

      • active - Connection or permissions required to read the results of the resource discovery are intact.
      • not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the AWS RAM resource share is still intact.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The lifecycle state of the association when you associate or disassociate a resource discovery.

      • associate-in-progress - Resource discovery is being associated.
      • associate-complete - Resource discovery association is complete.
      • associate-failed - Resource discovery association has failed.
      • disassociate-in-progress - Resource discovery is being disassociated.
      • disassociate-complete - Resource discovery disassociation is complete.
      • disassociate-failed - Resource discovery disassociation has failed.
      • isolate-in-progress - AWS account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.
      • isolate-complete - Resource discovery isolation is complete..
      • restore-in-progress - Resource discovery is being restored.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A tag is a label that you assign to an AWS resource.

      Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.

    • getIpamId

      @Stability(Stable) @NotNull public String getIpamId()
      The IPAM ID.

    • setIpamId

      @Stability(Stable) public void setIpamId(@NotNull String value)
      The IPAM ID.

    • getIpamResourceDiscoveryId

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

    • setIpamResourceDiscoveryId

      @Stability(Stable) public void setIpamResourceDiscoveryId(@NotNull String value)
      The resource discovery ID.