Class CfnAccessPolicy

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnAccessPolicy
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAccessPolicy : CfnResource, IInspectable, IAccessPolicyRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnAccessPolicy Inherits CfnResource Implements IInspectable, IAccessPolicyRef, IConstruct, IDependable, IEnvironmentAware
Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

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 AWS::IoTSiteWise::AccessPolicy.

Properties

AccessPolicyIdentity

The identity for this access policy.
AccessPolicyPermission

The permission level for this access policy.
AccessPolicyRef

A reference to a AccessPolicy resource.
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

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .
CfnPropertyNames

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

Methods

ArnForAccessPolicy(IAccessPolicyRef)

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .
FromAccessPolicyArn(Construct, string, string)

Creates a new IAccessPolicyRef from an ARN.
FromAccessPolicyId(Construct, string, string)

Creates a new IAccessPolicyRef from a accessPolicyId.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnAccessPolicy(object)

Checks whether the given object is a CfnAccessPolicy.
RenderProperties(IDictionary<string, object>)

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

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 string

Construct identifier for this resource (unique in its scope).

props ICfnAccessPolicyProps

Resource properties.

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

Properties

AccessPolicyIdentity

The identity for this access policy.

public virtual object AccessPolicyIdentity { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnAccessPolicy.IAccessPolicyIdentityProperty

AccessPolicyPermission

The permission level for this access policy.

public virtual string AccessPolicyPermission { get; set; }
Property Value

string

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

AccessPolicyRef

A reference to a AccessPolicy resource.

public virtual IAccessPolicyReference AccessPolicyRef { get; }
Property Value

IAccessPolicyReference

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

AccessPolicyResource

The AWS IoT SiteWise Monitor resource for this access policy.

public virtual object AccessPolicyResource { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnAccessPolicy.IAccessPolicyResourceProperty

AttrAccessPolicyArn

The ARN of the access policy, which has the following format.

public virtual string AttrAccessPolicyArn { get; }
Property Value

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

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

string

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

CfnProperties

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

Methods

ArnForAccessPolicy(IAccessPolicyRef)

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

public static string ArnForAccessPolicy(IAccessPolicyRef resource)
Parameters
resource IAccessPolicyRef
Returns

string

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

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"
                     }
                 }
             });

FromAccessPolicyArn(Construct, string, string)

Creates a new IAccessPolicyRef from an ARN.

public static IAccessPolicyRef FromAccessPolicyArn(Construct scope, string id, string arn)
Parameters
scope Construct
id string
arn string
Returns

IAccessPolicyRef

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

FromAccessPolicyId(Construct, string, string)

Creates a new IAccessPolicyRef from a accessPolicyId.

public static IAccessPolicyRef FromAccessPolicyId(Construct scope, string id, string accessPolicyId)
Parameters
scope Construct
id string
accessPolicyId string
Returns

IAccessPolicyRef

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

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.

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

IsCfnAccessPolicy(object)

Checks whether the given object is a CfnAccessPolicy.

public static bool IsCfnAccessPolicy(object x)
Parameters
x object
Returns

bool

Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html

CloudformationResource: AWS::IoTSiteWise::AccessPolicy

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable