Package software.amazon.awscdk.services.iot

Class CfnPolicyPrincipalAttachment

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:09.478Z")
@Stability(Stable)
public class CfnPolicyPrincipalAttachment
extends CfnResource
implements IInspectable

Use the AWS::IoT::PolicyPrincipalAttachment resource to attach an AWS IoT policy to a principal (an X.509 certificate or other credential).

For information about working with AWS IoT policies 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.*;
 CfnPolicyPrincipalAttachment cfnPolicyPrincipalAttachment = CfnPolicyPrincipalAttachment.Builder.create(this, "MyCfnPolicyPrincipalAttachment")
         .policyName("policyName")
         .principal("principal")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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

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

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getPolicyName()	The name of the AWS IoT policy.
String	getPrincipal()	The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPolicyName(String value)	The name of the AWS IoT policy.
void	setPrincipal(String value)	The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

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

CfnPolicyPrincipalAttachment

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

CfnPolicyPrincipalAttachment

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

CfnPolicyPrincipalAttachment

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

getPolicyName

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

The name of the AWS IoT policy.

setPolicyName

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

The name of the AWS IoT policy.

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.