Class CfnAccessPolicy
A CloudFormation AWS::IoTSiteWise::AccessPolicy
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.AWS.IoTSiteWise.dll
Syntax (csharp)
public class CfnAccessPolicy : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAccessPolicy
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.
CloudformationResource: AWS::IoTSiteWise::AccessPolicy
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTSiteWise;
var cfnAccessPolicy = new CfnAccessPolicy(this, "MyCfnAccessPolicy", new CfnAccessPolicyProps {
AccessPolicyIdentity = new AccessPolicyIdentityProperty {
IamRole = new IamRoleProperty {
Arn = "arn"
},
IamUser = new IamUserProperty {
Arn = "arn"
},
User = new UserProperty {
Id = "id"
}
},
AccessPolicyPermission = "accessPolicyPermission",
AccessPolicyResource = new AccessPolicyResourceProperty {
Portal = new PortalProperty {
Id = "id"
},
Project = new ProjectProperty {
Id = "id"
}
}
});
Synopsis
Constructors
CfnAccessPolicy(Construct, String, ICfnAccessPolicyProps) | Create a new |
CfnAccessPolicy(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAccessPolicy(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AccessPolicyIdentity | The identity for this access policy. |
AccessPolicyPermission | The permission level for this access policy. |
AccessPolicyResource | The AWS IoT SiteWise Monitor resource for this access policy. |
AttrAccessPolicyArn | The ARN of the access policy, which has the following format. |
AttrAccessPolicyId | The ID of the access policy. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAccessPolicy(Construct, String, ICfnAccessPolicyProps)
Create a new AWS::IoTSiteWise::AccessPolicy
.
public CfnAccessPolicy(Construct scope, string id, ICfnAccessPolicyProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAccessPolicyProps
- resource properties.
CfnAccessPolicy(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAccessPolicy(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAccessPolicy(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAccessPolicy(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AccessPolicyIdentity
The identity for this access policy.
public virtual object AccessPolicyIdentity { get; set; }
Property Value
System.Object
Remarks
Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
AccessPolicyPermission
The permission level for this access policy.
public virtual string AccessPolicyPermission { get; set; }
Property Value
System.String
Remarks
Choose either a ADMINISTRATOR
or VIEWER
. Note that a project ADMINISTRATOR
is also known as a project owner.
AccessPolicyResource
The AWS IoT SiteWise Monitor resource for this access policy.
public virtual object AccessPolicyResource { get; set; }
Property Value
System.Object
Remarks
Choose either a portal or a project.
AttrAccessPolicyArn
The ARN of the access policy, which has the following format.
public virtual string AttrAccessPolicyArn { get; }
Property Value
System.String
Remarks
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
CloudformationAttribute: AccessPolicyArn
AttrAccessPolicyId
The ID of the access policy.
public virtual string AttrAccessPolicyId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AccessPolicyId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>