Package software.amazon.awscdk.services.mgn

Class CfnConnector

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.CfnConnector
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IConnectorRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:56.182Z") @Stability(Stable) public class CfnConnector extends CfnResource implements IInspectable, IConnectorRef, ITaggableV2
Resource schema for AWS::MGN::Connector.

A Connector provides connectivity between a source environment and Application Migration Service (MGN) via AWS Systems Manager (SSM).

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.*;
 CfnConnector cfnConnector = CfnConnector.Builder.create(this, "MyCfnConnector")
         .name("name")
         .ssmInstanceId("ssmInstanceId")
         // the properties below are optional
         .ssmCommandConfig(ConnectorSsmCommandConfigProperty.builder()
                 .cloudWatchOutputEnabled(false)
                 .s3OutputEnabled(false)
                 // the properties below are optional
                 .cloudWatchLogGroupName("cloudWatchLogGroupName")
                 .outputS3BucketName("outputS3BucketName")
                 .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

    • CfnConnector

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

    • CfnConnector

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

    • CfnConnector

      @Stability(Stable) public CfnConnector(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConnectorProps props)
      Create a new AWS::MGN::Connector.

      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

    • arnForConnector

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

    • isCfnConnector

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

      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 connector.

    • getAttrConnectorId

      @Stability(Stable) @NotNull public String getAttrConnectorId()
      The unique identifier of the connector.

    • 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

    • getConnectorRef

      @Stability(Stable) @NotNull public ConnectorReference getConnectorRef()
      A reference to a Connector resource.
      Specified by:
      getConnectorRef in interface IConnectorRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the connector.

    • setName

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

    • getSsmInstanceId

      @Stability(Stable) @NotNull public String getSsmInstanceId()
      The SSM instance ID associated with this connector.

    • setSsmInstanceId

      @Stability(Stable) public void setSsmInstanceId(@NotNull String value)
      The SSM instance ID associated with this connector.

    • getSsmCommandConfig

      @Stability(Stable) @Nullable public Object getSsmCommandConfig()
      SSM command configuration for the connector.

      Returns union: either IResolvable or CfnConnector.ConnectorSsmCommandConfigProperty

    • setSsmCommandConfig

      @Stability(Stable) public void setSsmCommandConfig(@Nullable IResolvable value)
      SSM command configuration for the connector.

    • setSsmCommandConfig

      @Stability(Stable) public void setSsmCommandConfig(@Nullable CfnConnector.ConnectorSsmCommandConfigProperty value)
      SSM command configuration for the connector.

    • getTags

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

    • setTags

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