Package software.amazon.awscdk.services.connect

Class CfnUserHierarchyGroup

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.connect.CfnUserHierarchyGroup

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-04T00:39:30.128Z")
@Stability(Stable)
public class CfnUserHierarchyGroup
extends CfnResource
implements IInspectable, ITaggableV2

Specifies a new user hierarchy group.

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.connect.*;
 CfnUserHierarchyGroup cfnUserHierarchyGroup = CfnUserHierarchyGroup.Builder.create(this, "MyCfnUserHierarchyGroup")
         .instanceArn("instanceArn")
         .name("name")
         // the properties below are optional
         .parentGroupArn("parentGroupArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-userhierarchygroup.html

Nested Class Summary

Nested Classes

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

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	CfnUserHierarchyGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserHierarchyGroup(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUserHierarchyGroup(software.constructs.Construct scope, String id, CfnUserHierarchyGroupProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrUserHierarchyGroupArn()	The Amazon Resource Name (ARN) of the user hierarchy group.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getInstanceArn()	The Amazon Resource Name (ARN) of the user hierarchy group.
String	getName()	The name of the user hierarchy group.
String	getParentGroupArn()	The Amazon Resource Name (ARN) of the parent group.
List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setInstanceArn(String value)	The Amazon Resource Name (ARN) of the user hierarchy group.
void	setName(String value)	The name of the user hierarchy group.
void	setParentGroupArn(String value)	The Amazon Resource Name (ARN) of the parent group.
void	setTags(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

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

CfnUserHierarchyGroup

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

CfnUserHierarchyGroup

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

CfnUserHierarchyGroup

@Stability(Stable)
public CfnUserHierarchyGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnUserHierarchyGroupProps 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.

getAttrUserHierarchyGroupArn

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

The Amazon Resource Name (ARN) of the user hierarchy group.

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

getInstanceArn

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

The Amazon Resource Name (ARN) of the user hierarchy group.

setInstanceArn

@Stability(Stable)
public void setInstanceArn(@NotNull
 String value)

The Amazon Resource Name (ARN) of the user hierarchy group.

getName

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

The name of the user hierarchy group.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the user hierarchy group.

getParentGroupArn

@Stability(Stable)
@Nullable
public String getParentGroupArn()

The Amazon Resource Name (ARN) of the parent group.

setParentGroupArn

@Stability(Stable)
public void setParentGroupArn(@Nullable
 String value)

The Amazon Resource Name (ARN) of the parent group.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

An array of key-value pairs to apply to this resource.