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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.028Z")
 @Stability(value=Stable)
public class CfnAccessPolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTSiteWise::AccessPolicy`.

Creates an access policy that grants the specified identity ( AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnAccessPolicy.AccessPolicyIdentityProperty The identity ( AWS SSO user, AWS SSO group, or IAM user) to which this access policy applies.
static interface	CfnAccessPolicy.AccessPolicyResourceProperty The AWS IoT SiteWise Monitor resource for this access policy.
static class	CfnAccessPolicy.Builder A fluent builder for CfnAccessPolicy.
static interface	CfnAccessPolicy.IamRoleProperty Contains information about an AWS Identity and Access Management role.
static interface	CfnAccessPolicy.IamUserProperty Contains information about an AWS Identity and Access Management user.
static interface	CfnAccessPolicy.PortalProperty The `Portal` property type specifies the AWS IoT SiteWise Monitor portal for an [AWS::IoTSiteWise::AccessPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html) .
static interface	CfnAccessPolicy.ProjectProperty The `Project` property type specifies the AWS IoT SiteWise Monitor project for an [AWS::IoTSiteWise::AccessPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html) .
static interface	CfnAccessPolicy.UserProperty The `User` property type specifies the AWS IoT SiteWise Monitor user for an [AWS::IoTSiteWise::AccessPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html) .

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAccessPolicy(software.constructs.Construct scope, String id, CfnAccessPolicyProps props) Create a new `AWS::IoTSiteWise::AccessPolicy`.
protected	CfnAccessPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAccessPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAccessPolicyIdentity() The identity for this access policy.
String	getAccessPolicyPermission() The permission level for this access policy.
Object	getAccessPolicyResource() The AWS IoT SiteWise Monitor resource for this access policy.
String	getAttrAccessPolicyArn() The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the access policy, which has the following format.
String	getAttrAccessPolicyId() The ID of the access policy.
protected Map<String,Object>	getCfnProperties()
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessPolicyIdentity(CfnAccessPolicy.AccessPolicyIdentityProperty value) The identity for this access policy.
void	setAccessPolicyIdentity(IResolvable value) The identity for this access policy.
void	setAccessPolicyPermission(String value) The permission level for this access policy.
void	setAccessPolicyResource(CfnAccessPolicy.AccessPolicyResourceProperty value) The AWS IoT SiteWise Monitor resource for this access policy.
void	setAccessPolicyResource(IResolvable value) The AWS IoT SiteWise Monitor resource for this access policy.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAccessPolicy

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

CfnAccessPolicy

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

CfnAccessPolicy

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAccessPolicyArn

@Stability(value=Stable)
 @NotNull
public String getAttrAccessPolicyArn()

The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the access policy, which has the following format.

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

getAttrAccessPolicyId

@Stability(value=Stable)
 @NotNull
public String getAttrAccessPolicyId()

The ID of the access policy.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAccessPolicyIdentity

@Stability(value=Stable)
 @NotNull
public Object getAccessPolicyIdentity()

The identity for this access policy.

Choose an AWS SSO user, an AWS SSO group, or an IAM user.

setAccessPolicyIdentity

@Stability(value=Stable)
public void setAccessPolicyIdentity(@NotNull
                                                             CfnAccessPolicy.AccessPolicyIdentityProperty value)

The identity for this access policy.

Choose an AWS SSO user, an AWS SSO group, or an IAM user.

setAccessPolicyIdentity

@Stability(value=Stable)
public void setAccessPolicyIdentity(@NotNull
                                                             IResolvable value)

The identity for this access policy.

Choose an AWS SSO user, an AWS SSO group, or an IAM user.

getAccessPolicyPermission

@Stability(value=Stable)
 @NotNull
public String getAccessPolicyPermission()

The permission level for this access policy.

Choose either a ADMINISTRATOR or VIEWER . Note that a project ADMINISTRATOR is also known as a project owner.

setAccessPolicyPermission

@Stability(value=Stable)
public void setAccessPolicyPermission(@NotNull
                                                               String value)

The permission level for this access policy.

Choose either a ADMINISTRATOR or VIEWER . Note that a project ADMINISTRATOR is also known as a project owner.

getAccessPolicyResource

@Stability(value=Stable)
 @NotNull
public Object getAccessPolicyResource()

The AWS IoT SiteWise Monitor resource for this access policy.

Choose either a portal or a project.

setAccessPolicyResource

@Stability(value=Stable)
public void setAccessPolicyResource(@NotNull
                                                             CfnAccessPolicy.AccessPolicyResourceProperty value)

The AWS IoT SiteWise Monitor resource for this access policy.

Choose either a portal or a project.

setAccessPolicyResource

@Stability(value=Stable)
public void setAccessPolicyResource(@NotNull
                                                             IResolvable value)

The AWS IoT SiteWise Monitor resource for this access policy.

Choose either a portal or a project.