Package software.amazon.awscdk.services.iot

Class CfnThingPrincipalAttachment

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.iot.CfnThingPrincipalAttachment

All Implemented Interfaces:

IEnvironmentAware, IInspectable, IThingPrincipalAttachmentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:07.634Z")
@Stability(Stable)
public class CfnThingPrincipalAttachment
extends CfnResource
implements IInspectable, IThingPrincipalAttachmentRef

Use the AWS::IoT::ThingPrincipalAttachment resource to attach a principal (an X.509 certificate or another credential) to a thing.

For more information about working with AWS IoT things and principals, see Authorization in the AWS IoT Developer Guide .

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.iot.*;
 CfnThingPrincipalAttachment cfnThingPrincipalAttachment = CfnThingPrincipalAttachment.Builder.create(this, "MyCfnThingPrincipalAttachment")
         .principal("principal")
         .thingName("thingName")
         // the properties below are optional
         .thingPrincipalType("thingPrincipalType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingprincipalattachment.html

Nested Class Summary

Nested Classes

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

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.services.iot.IThingPrincipalAttachmentRef

IThingPrincipalAttachmentRef.Jsii$Default, IThingPrincipalAttachmentRef.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	CfnThingPrincipalAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnThingPrincipalAttachment(software.amazon.jsii.JsiiObjectRef objRef)
	CfnThingPrincipalAttachment(software.constructs.Construct scope, String id, CfnThingPrincipalAttachmentProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getPrincipal()	The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
String	getThingName()	The name of the AWS IoT thing.
ThingPrincipalAttachmentReference	getThingPrincipalAttachmentRef()	A reference to a ThingPrincipalAttachment resource.
String	getThingPrincipalType()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPrincipal(String value)	The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
void	setThingName(String value)	The name of the AWS IoT thing.
void	setThingPrincipalType(String value)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

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

CfnThingPrincipalAttachment

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

CfnThingPrincipalAttachment

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

CfnThingPrincipalAttachment

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

getAttrId

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

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getThingPrincipalAttachmentRef

@Stability(Stable)
@NotNull
public ThingPrincipalAttachmentReference getThingPrincipalAttachmentRef()

A reference to a ThingPrincipalAttachment resource.

Specified by:

getThingPrincipalAttachmentRef in interface IThingPrincipalAttachmentRef

getPrincipal

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

The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

setPrincipal

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

The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

getThingName

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

The name of the AWS IoT thing.

setThingName

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

The name of the AWS IoT thing.

getThingPrincipalType

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

setThingPrincipalType

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