Package software.amazon.awscdk.services.mgn

Class CfnNetworkMigrationDefinition

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.mgn.CfnNetworkMigrationDefinition
All Implemented Interfaces:
IInspectable, IEnvironmentAware, INetworkMigrationDefinitionRef, 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:14.164Z") @Stability(Stable) public class CfnNetworkMigrationDefinition extends CfnResource implements IInspectable, INetworkMigrationDefinitionRef, ITaggableV2
Resource schema for AWS::MGN::NetworkMigrationDefinition.

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.mgn.*;
 CfnNetworkMigrationDefinition cfnNetworkMigrationDefinition = CfnNetworkMigrationDefinition.Builder.create(this, "MyCfnNetworkMigrationDefinition")
         .name("name")
         .sourceConfigurations(List.of(SourceConfigurationProperty.builder()
                 .sourceEnvironment("sourceEnvironment")
                 .sourceS3Configuration(SourceS3ConfigurationProperty.builder()
                         .s3Bucket("s3Bucket")
                         .s3BucketOwner("s3BucketOwner")
                         .s3Key("s3Key")
                         .build())
                 .build()))
         .targetNetwork(TargetNetworkProperty.builder()
                 .topology("topology")
                 // the properties below are optional
                 .inboundCidr("inboundCidr")
                 .inspectionCidr("inspectionCidr")
                 .outboundCidr("outboundCidr")
                 .build())
         .targetS3Configuration(TargetS3ConfigurationProperty.builder()
                 .s3Bucket("s3Bucket")
                 .s3BucketOwner("s3BucketOwner")
                 .build())
         // the properties below are optional
         .description("description")
         .scopeTags(Map.of(
                 "scopeTagsKey", "scopeTags"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetDeployment("targetDeployment")
         .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

    • CfnNetworkMigrationDefinition

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

    • CfnNetworkMigrationDefinition

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

    • CfnNetworkMigrationDefinition

      @Stability(Stable) public CfnNetworkMigrationDefinition(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnNetworkMigrationDefinitionProps props)
      Create a new AWS::MGN::NetworkMigrationDefinition.

      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

    • arnForNetworkMigrationDefinition

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

    • isCfnNetworkMigrationDefinition

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

      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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the network migration definition.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the network migration definition was created.

    • getAttrNetworkMigrationDefinitionId

      @Stability(Stable) @NotNull public String getAttrNetworkMigrationDefinitionId()
      The unique identifier of the network migration definition.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp when the network migration definition was last updated.

    • 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

    • getNetworkMigrationDefinitionRef

      @Stability(Stable) @NotNull public NetworkMigrationDefinitionReference getNetworkMigrationDefinitionRef()
      A reference to a NetworkMigrationDefinition resource.
      Specified by:
      getNetworkMigrationDefinitionRef in interface INetworkMigrationDefinitionRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the network migration definition.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the network migration definition.

    • getSourceConfigurations

      @Stability(Stable) @NotNull public Object getSourceConfigurations()
      A list of source configurations for the network migration.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnNetworkMigrationDefinition.SourceConfigurationProperty>

    • setSourceConfigurations

      @Stability(Stable) public void setSourceConfigurations(@NotNull IResolvable value)
      A list of source configurations for the network migration.

    • setSourceConfigurations

      @Stability(Stable) public void setSourceConfigurations(@NotNull List<Object> value)
      A list of source configurations for the network migration.

    • getTargetNetwork

      @Stability(Stable) @NotNull public Object getTargetNetwork()
      Configuration for the target network topology and addressing.

      Returns union: either IResolvable or CfnNetworkMigrationDefinition.TargetNetworkProperty

    • setTargetNetwork

      @Stability(Stable) public void setTargetNetwork(@NotNull IResolvable value)
      Configuration for the target network topology and addressing.

    • setTargetNetwork

      @Stability(Stable) public void setTargetNetwork(@NotNull CfnNetworkMigrationDefinition.TargetNetworkProperty value)
      Configuration for the target network topology and addressing.

    • getTargetS3Configuration

      @Stability(Stable) @NotNull public Object getTargetS3Configuration()
      S3 configuration for storing target network artifacts.

      Returns union: either IResolvable or CfnNetworkMigrationDefinition.TargetS3ConfigurationProperty

    • setTargetS3Configuration

      @Stability(Stable) public void setTargetS3Configuration(@NotNull IResolvable value)
      S3 configuration for storing target network artifacts.

    • setTargetS3Configuration

      @Stability(Stable) public void setTargetS3Configuration(@NotNull CfnNetworkMigrationDefinition.TargetS3ConfigurationProperty value)
      S3 configuration for storing target network artifacts.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the network migration definition.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the network migration definition.

    • getScopeTags

      @Stability(Stable) @Nullable public Object getScopeTags()
      Scope tags map for the network migration definition.

      Returns union: either IResolvable or Mapinvalid input: '<'String, String>

    • setScopeTags

      @Stability(Stable) public void setScopeTags(@Nullable IResolvable value)
      Scope tags map for the network migration definition.

    • setScopeTags

      @Stability(Stable) public void setScopeTags(@Nullable Map<String,String> value)
      Scope tags map for the network migration definition.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags to assign to the network migration definition.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags to assign to the network migration definition.

    • getTargetDeployment

      @Stability(Stable) @Nullable public String getTargetDeployment()
      The target deployment configuration for the migrated network.

    • setTargetDeployment

      @Stability(Stable) public void setTargetDeployment(@Nullable String value)
      The target deployment configuration for the migrated network.