Package software.amazon.awscdk.services.pcaconnectorad

Class CfnDirectoryRegistration

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

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:05.175Z")
@Stability(Stable)
public class CfnDirectoryRegistration
extends CfnResource
implements IInspectable, ITaggableV2

Creates a directory registration that authorizes communication between AWS Private CA and an Active Directory.

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.*;
 CfnDirectoryRegistration cfnDirectoryRegistration = CfnDirectoryRegistration.Builder.create(this, "MyCfnDirectoryRegistration")
         .directoryId("directoryId")
         // the properties below are optional
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-directoryregistration.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDirectoryRegistration.Builder	A fluent builder for CfnDirectoryRegistration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDirectoryRegistration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDirectoryRegistration(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDirectoryRegistration(software.constructs.Construct scope, String id, CfnDirectoryRegistrationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrDirectoryRegistrationArn()	The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration .
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDirectoryId()	The identifier of the Active Directory.
Map<String,String>	getTags()	Metadata assigned to a directory registration consisting of a key-value pair.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDirectoryId(String value)	The identifier of the Active Directory.
void	setTags(Map<String,String> value)	Metadata assigned to a directory registration consisting of a key-value pair.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnDirectoryRegistration

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

CfnDirectoryRegistration

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

CfnDirectoryRegistration

@Stability(Stable)
public CfnDirectoryRegistration(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDirectoryRegistrationProps props)

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.

getAttrDirectoryRegistrationArn

@Stability(Stable)
@NotNull
public String getAttrDirectoryRegistrationArn()

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration .

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

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.

getTags

@Stability(Stable)
@Nullable
public Map<String,String> getTags()

Metadata assigned to a directory registration consisting of a key-value pair.

setTags

@Stability(Stable)
public void setTags(@Nullable
 Map<String,String> value)

Metadata assigned to a directory registration consisting of a key-value pair.