Package software.amazon.awscdk.services.ssm

Class CfnCloudConnector

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.ssm.CfnCloudConnector
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ICloudConnectorRef, 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:19.712Z") @Stability(Stable) public class CfnCloudConnector extends CfnResource implements IInspectable, ICloudConnectorRef, ITaggableV2
Resource Type definition for AWS::SSM::CloudConnector.

Enables AWS Systems Manager to manage resources in external cloud providers.

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.ssm.*;
 CfnCloudConnector cfnCloudConnector = CfnCloudConnector.Builder.create(this, "MyCfnCloudConnector")
         .configConnectorArn("configConnectorArn")
         .configuration(CloudConnectorConfigurationProperty.builder()
                 .azureConfiguration(AzureConfigurationProperty.builder()
                         .applicationId("applicationId")
                         .tenantId("tenantId")
                         // the properties below are optional
                         .applicationDisplayName("applicationDisplayName")
                         .targets(ConfigurationTargetsProperty.builder()
                                 .subscriptions(List.of(AzureSubscriptionProperty.builder()
                                         .id("id")
                                         // the properties below are optional
                                         .displayName("displayName")
                                         .build()))
                                 .build())
                         .tenantDisplayName("tenantDisplayName")
                         .build())
                 .build())
         .displayName("displayName")
         .roleArn("roleArn")
         // the properties below are optional
         .description("description")
         .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

    • CfnCloudConnector

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

    • CfnCloudConnector

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

    • CfnCloudConnector

      @Stability(Stable) public CfnCloudConnector(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCloudConnectorProps props)
      Create a new AWS::SSM::CloudConnector.

      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

    • arnForCloudConnector

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

    • isCfnCloudConnector

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

      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.

    • getAttrCloudConnectorArn

      @Stability(Stable) @NotNull public String getAttrCloudConnectorArn()
      The ARN of the cloud connector.

    • getAttrCloudConnectorId

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

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the cloud connector was created.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp when the cloud connector 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

    • getCloudConnectorRef

      @Stability(Stable) @NotNull public CloudConnectorReference getCloudConnectorRef()
      A reference to a CloudConnector resource.
      Specified by:
      getCloudConnectorRef in interface ICloudConnectorRef

    • getConfigConnectorArn

      @Stability(Stable) @NotNull public String getConfigConnectorArn()
      The ARN of the AWS Config connector.

    • setConfigConnectorArn

      @Stability(Stable) public void setConfigConnectorArn(@NotNull String value)
      The ARN of the AWS Config connector.

    • getConfiguration

      @Stability(Stable) @NotNull public Object getConfiguration()
      The configuration for the cloud connector.

      Returns union: either IResolvable or CfnCloudConnector.CloudConnectorConfigurationProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull IResolvable value)
      The configuration for the cloud connector.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull CfnCloudConnector.CloudConnectorConfigurationProperty value)
      The configuration for the cloud connector.

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The display name of the cloud connector.

    • setDisplayName

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

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The IAM role ARN used by the cloud connector.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The IAM role ARN used by the cloud connector.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the cloud connector.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the cloud connector.

    • getTags

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

    • setTags

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