Package software.amazon.awscdk.services.iotsitewise

Class CfnAccessPolicy

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.iotsitewise.CfnAccessPolicy
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAccessPolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.456Z") @Stability(Stable) public class CfnAccessPolicy extends CfnResource implements IInspectable, IAccessPolicyRef

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

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.

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.iotsitewise.*;
 CfnAccessPolicy cfnAccessPolicy = CfnAccessPolicy.Builder.create(this, "MyCfnAccessPolicy")
         .accessPolicyIdentity(AccessPolicyIdentityProperty.builder()
                 .iamRole(IamRoleProperty.builder()
                         .arn("arn")
                         .build())
                 .iamUser(IamUserProperty.builder()
                         .arn("arn")
                         .build())
                 .user(UserProperty.builder()
                         .id("id")
                         .build())
                 .build())
         .accessPolicyPermission("accessPolicyPermission")
         .accessPolicyResource(AccessPolicyResourceProperty.builder()
                 .portal(PortalProperty.builder()
                         .id("id")
                         .build())
                 .project(ProjectProperty.builder()
                         .id("id")
                         .build())
                 .build())
         .build();

See Also:

  • 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

    • CfnAccessPolicy

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

    • CfnAccessPolicy

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

    • CfnAccessPolicy

      @Stability(Stable) public CfnAccessPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAccessPolicyProps props)
      Create a new AWS::IoTSiteWise::AccessPolicy.

      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

    • arnForAccessPolicy

      @Stability(Stable) @NotNull public static String arnForAccessPolicy(@NotNull IAccessPolicyRef resource)
      Parameters:
      resource - This parameter is required.

    • fromAccessPolicyArn

      @Stability(Stable) @NotNull public static IAccessPolicyRef fromAccessPolicyArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IAccessPolicyRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromAccessPolicyId

      @Stability(Stable) @NotNull public static IAccessPolicyRef fromAccessPolicyId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String accessPolicyId)
      Creates a new IAccessPolicyRef from a accessPolicyId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      accessPolicyId - This parameter is required.

    • isCfnAccessPolicy

      @Stability(Stable) @NotNull public static Boolean isCfnAccessPolicy(@NotNull Object x)
      Checks whether the given object is a CfnAccessPolicy.

      Parameters:
      x - This parameter is required.

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

    • getAccessPolicyRef

      @Stability(Stable) @NotNull public AccessPolicyReference getAccessPolicyRef()
      A reference to a AccessPolicy resource.
      Specified by:
      getAccessPolicyRef in interface IAccessPolicyRef

    • getAttrAccessPolicyArn

      @Stability(Stable) @NotNull public String getAttrAccessPolicyArn()
      The ARN of the access policy, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

    • getAttrAccessPolicyId

      @Stability(Stable) @NotNull public String getAttrAccessPolicyId()
      The ID of the access policy.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAccessPolicyIdentity

      @Stability(Stable) @NotNull public Object getAccessPolicyIdentity()
      The identity for this access policy.

      Returns union: either IResolvable or CfnAccessPolicy.AccessPolicyIdentityProperty

    • setAccessPolicyIdentity

      @Stability(Stable) public void setAccessPolicyIdentity(@NotNull IResolvable value)
      The identity for this access policy.

    • setAccessPolicyIdentity

      @Stability(Stable) public void setAccessPolicyIdentity(@NotNull CfnAccessPolicy.AccessPolicyIdentityProperty value)
      The identity for this access policy.

    • getAccessPolicyPermission

      @Stability(Stable) @NotNull public String getAccessPolicyPermission()
      The permission level for this access policy.

    • setAccessPolicyPermission

      @Stability(Stable) public void setAccessPolicyPermission(@NotNull String value)
      The permission level for this access policy.

    • getAccessPolicyResource

      @Stability(Stable) @NotNull public Object getAccessPolicyResource()
      The AWS IoT SiteWise Monitor resource for this access policy.

      Returns union: either IResolvable or CfnAccessPolicy.AccessPolicyResourceProperty

    • setAccessPolicyResource

      @Stability(Stable) public void setAccessPolicyResource(@NotNull IResolvable value)
      The AWS IoT SiteWise Monitor resource for this access policy.

    • setAccessPolicyResource

      @Stability(Stable) public void setAccessPolicyResource(@NotNull CfnAccessPolicy.AccessPolicyResourceProperty value)
      The AWS IoT SiteWise Monitor resource for this access policy.