@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.820Z") 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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnPolicyPrincipalAttachment.Builder
A fluent builder for
CfnPolicyPrincipalAttachment . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnPolicyPrincipalAttachment(Construct scope,
java.lang.String id,
CfnPolicyPrincipalAttachmentProps props)
Create a new `AWS::IoT::PolicyPrincipalAttachment`.
|
protected |
CfnPolicyPrincipalAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnPolicyPrincipalAttachment(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getPolicyName()
The name of the AWS IoT policy.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setPolicyName(java.lang.String value)
The name of the AWS IoT policy.
|
void |
setPrincipal(java.lang.String value)
The principal, which can be a certificate ARN (as returned from the `CreateCertificate` operation) or an Amazon Cognito ID.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnPolicyPrincipalAttachment(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnPolicyPrincipalAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnPolicyPrincipalAttachment(Construct scope, java.lang.String id, CfnPolicyPrincipalAttachmentProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getPolicyName()
public void setPolicyName(java.lang.String value)
public java.lang.String getPrincipal()
public void setPrincipal(java.lang.String value)