Package software.amazon.awscdk.services.pcaconnectorad

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.pcaconnectorad.CfnConnector
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IConnectorRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:10.143Z") @Stability(Stable) public class CfnConnector extends CfnResource implements IInspectable, IConnectorRef, ITaggableV2
Creates a connector between AWS Private CA and an Active Directory.

You must specify the private CA, directory ID, and security groups.

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.pcaconnectorad.*;
 CfnConnector cfnConnector = CfnConnector.Builder.create(this, "MyCfnConnector")
         .certificateAuthorityArn("certificateAuthorityArn")
         .directoryId("directoryId")
         .vpcInformation(VpcInformationProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 // the properties below are optional
                 .ipAddressType("ipAddressType")
                 .build())
         // the properties below are optional
         .tags(Map.of(
                 "tagsKey", "tags"))
         .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::PCAConnectorAD::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

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

    • getAttrConnectorArn

      @Stability(Stable) @NotNull public String getAttrConnectorArn()
      The Amazon Resource Name (ARN) that was returned when you called CreateConnector .

    • 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

    • getConnectorRef

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

    • getCertificateAuthorityArn

      @Stability(Stable) @NotNull public String getCertificateAuthorityArn()
      The Amazon Resource Name (ARN) of the certificate authority being used.

    • setCertificateAuthorityArn

      @Stability(Stable) public void setCertificateAuthorityArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the certificate authority being used.

    • getDirectoryId

      @Stability(Stable) @NotNull public String getDirectoryId()
      The identifier of the Active Directory.

    • setDirectoryId

      @Stability(Stable) public void setDirectoryId(@NotNull String value)
      The identifier of the Active Directory.

    • getVpcInformation

      @Stability(Stable) @NotNull public Object getVpcInformation()
      Information of the VPC and security group(s) used with the connector.

      Returns union: either IResolvable or CfnConnector.VpcInformationProperty

    • setVpcInformation

      @Stability(Stable) public void setVpcInformation(@NotNull IResolvable value)
      Information of the VPC and security group(s) used with the connector.

    • setVpcInformation

      @Stability(Stable) public void setVpcInformation(@NotNull CfnConnector.VpcInformationProperty value)
      Information of the VPC and security group(s) used with the connector.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      Metadata assigned to a connector consisting of a key-value pair.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      Metadata assigned to a connector consisting of a key-value pair.