Package software.amazon.awscdk.services.ec2

Class CfnIpamExternalResourceVerificationToken

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.CfnIpamExternalResourceVerificationToken
All Implemented Interfaces:
IInspectable, IIpamExternalResourceVerificationTokenRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:08.293Z") @Stability(Stable) public class CfnIpamExternalResourceVerificationToken extends CfnResource implements IInspectable, IIpamExternalResourceVerificationTokenRef, ITaggableV2
A verification token is an AWS-generated random value that you can use to prove ownership of an external resource.

For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to AWS (BYOIP).

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.*;
 CfnIpamExternalResourceVerificationToken cfnIpamExternalResourceVerificationToken = CfnIpamExternalResourceVerificationToken.Builder.create(this, "MyCfnIpamExternalResourceVerificationToken")
         .ipamId("ipamId")
         // the properties below are optional
         .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

    • CfnIpamExternalResourceVerificationToken

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

    • CfnIpamExternalResourceVerificationToken

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

    • CfnIpamExternalResourceVerificationToken

      @Stability(Stable) public CfnIpamExternalResourceVerificationToken(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIpamExternalResourceVerificationTokenProps props)
      Create a new AWS::EC2::IpamExternalResourceVerificationToken.

      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. This parameter is required.

  • Method Details

    • arnForIpamExternalResourceVerificationToken

      @Stability(Stable) @NotNull public static String arnForIpamExternalResourceVerificationToken(@NotNull IIpamExternalResourceVerificationTokenRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnIpamExternalResourceVerificationToken

      @Stability(Stable) @NotNull public static Boolean isCfnIpamExternalResourceVerificationToken(@NotNull Object x)
      Checks whether the given object is a CfnIpamExternalResourceVerificationToken.

      Parameters:
      x - This parameter is required.

    • 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 ARN of the IPAM that created the token.

    • getAttrIpamExternalResourceVerificationTokenArn

      @Stability(Stable) @NotNull public String getAttrIpamExternalResourceVerificationTokenArn()
      The ARN of the IPAM external resource verification token.

    • getAttrIpamExternalResourceVerificationTokenId

      @Stability(Stable) @NotNull public String getAttrIpamExternalResourceVerificationTokenId()
      The ID of the token.

    • getAttrIpamRegion

      @Stability(Stable) @NotNull public String getAttrIpamRegion()
      The Region of the IPAM that created the token.

    • getAttrNotAfter

      @Stability(Stable) @NotNull public String getAttrNotAfter()
      The token expiration.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The token state.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The token status.

    • getAttrTokenName

      @Stability(Stable) @NotNull public String getAttrTokenName()
      The token name.

    • getAttrTokenValue

      @Stability(Stable) @NotNull public String getAttrTokenValue()
      The token value.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getIpamExternalResourceVerificationTokenRef

      @Stability(Stable) @NotNull public IpamExternalResourceVerificationTokenReference getIpamExternalResourceVerificationTokenRef()
      A reference to a IpamExternalResourceVerificationToken resource.
      Specified by:
      getIpamExternalResourceVerificationTokenRef in interface IIpamExternalResourceVerificationTokenRef

    • getIpamId

      @Stability(Stable) @NotNull public String getIpamId()
      The ID of the IPAM that will create the token.

    • setIpamId

      @Stability(Stable) public void setIpamId(@NotNull String value)
      The ID of the IPAM that will create the token.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags for the token.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags for the token.