CfnAccessPolicyPropsMixin

class aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnAccessPolicyPropsMixin(props, *, strategy=None)

Bases: Mixin

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. .. epigraph:

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
mixin:: true
exampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

cfn_access_policy_props_mixin = iotsitewise_mixins.CfnAccessPolicyPropsMixin(iotsitewise_mixins.CfnAccessPolicyMixinProps(
    access_policy_identity=iotsitewise_mixins.CfnAccessPolicyPropsMixin.AccessPolicyIdentityProperty(
        iam_role=iotsitewise_mixins.CfnAccessPolicyPropsMixin.IamRoleProperty(
            arn="arn"
        ),
        iam_user=iotsitewise_mixins.CfnAccessPolicyPropsMixin.IamUserProperty(
            arn="arn"
        ),
        user=iotsitewise_mixins.CfnAccessPolicyPropsMixin.UserProperty(
            id="id"
        )
    ),
    access_policy_permission="accessPolicyPermission",
    access_policy_resource=iotsitewise_mixins.CfnAccessPolicyPropsMixin.AccessPolicyResourceProperty(
        portal=iotsitewise_mixins.CfnAccessPolicyPropsMixin.PortalProperty(
            id="id"
        ),
        project=iotsitewise_mixins.CfnAccessPolicyPropsMixin.ProjectProperty(
            id="id"
        )
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTSiteWise::AccessPolicy.

Parameters:

props (Union[CfnAccessPolicyMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessPolicyIdentity', 'accessPolicyPermission', 'accessPolicyResource']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AccessPolicyIdentityProperty

class CfnAccessPolicyPropsMixin.AccessPolicyIdentityProperty(*, iam_role=None, iam_user=None, user=None)

Bases: object

The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.

Parameters:

iam_role (Union[IResolvable, IamRoleProperty, Dict[str, Any], None]) – An IAM role identity.
iam_user (Union[IResolvable, IamUserProperty, Dict[str, Any], None]) – An IAM user identity.
user (Union[IResolvable, UserProperty, Dict[str, Any], None]) – An IAM Identity Center user identity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

access_policy_identity_property = iotsitewise_mixins.CfnAccessPolicyPropsMixin.AccessPolicyIdentityProperty(
    iam_role=iotsitewise_mixins.CfnAccessPolicyPropsMixin.IamRoleProperty(
        arn="arn"
    ),
    iam_user=iotsitewise_mixins.CfnAccessPolicyPropsMixin.IamUserProperty(
        arn="arn"
    ),
    user=iotsitewise_mixins.CfnAccessPolicyPropsMixin.UserProperty(
        id="id"
    )
)

Attributes

iam_role

An IAM role identity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-iamrole

iam_user

An IAM user identity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-iamuser

user

An IAM Identity Center user identity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-user

AccessPolicyResourceProperty

class CfnAccessPolicyPropsMixin.AccessPolicyResourceProperty(*, portal=None, project=None)

Bases: object

The AWS IoT SiteWise Monitor resource for this access policy.

Choose either a portal or a project.

Parameters:

portal (Union[IResolvable, PortalProperty, Dict[str, Any], None]) – Identifies an AWS IoT SiteWise Monitor portal.
project (Union[IResolvable, ProjectProperty, Dict[str, Any], None]) – Identifies a specific AWS IoT SiteWise Monitor project.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

access_policy_resource_property = iotsitewise_mixins.CfnAccessPolicyPropsMixin.AccessPolicyResourceProperty(
    portal=iotsitewise_mixins.CfnAccessPolicyPropsMixin.PortalProperty(
        id="id"
    ),
    project=iotsitewise_mixins.CfnAccessPolicyPropsMixin.ProjectProperty(
        id="id"
    )
)

Attributes

portal

Identifies an AWS IoT SiteWise Monitor portal.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-portal

project

Identifies a specific AWS IoT SiteWise Monitor project.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-project

IamRoleProperty

class CfnAccessPolicyPropsMixin.IamRoleProperty(*, arn=None)

Bases: object

Contains information about an AWS Identity and Access Management role.

For more information, see IAM roles in the IAM User Guide .

Parameters:: arn (Optional[str]) – The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamrole.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

iam_role_property = iotsitewise_mixins.CfnAccessPolicyPropsMixin.IamRoleProperty(
    arn="arn"
)

Attributes

arn

The ARN of the IAM role.

For more information, see IAM ARNs in the IAM User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamrole.html#cfn-iotsitewise-accesspolicy-iamrole-arn

IamUserProperty

class CfnAccessPolicyPropsMixin.IamUserProperty(*, arn=None)

Bases: object

Contains information about an AWS Identity and Access Management user.

Parameters:

arn (Optional[str]) –

The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide . .. epigraph:: If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamuser.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

iam_user_property = iotsitewise_mixins.CfnAccessPolicyPropsMixin.IamUserProperty(
    arn="arn"
)

Attributes

arn

The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide .

If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamuser.html#cfn-iotsitewise-accesspolicy-iamuser-arn

PortalProperty

class CfnAccessPolicyPropsMixin.PortalProperty(*, id=None)

Bases: object

Identifies an AWS IoT SiteWise Monitor portal.

Parameters:: id (Optional[str]) – The ID of the portal.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-portal.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

portal_property = iotsitewise_mixins.CfnAccessPolicyPropsMixin.PortalProperty(
    id="id"
)

Attributes

id

The ID of the portal.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-portal.html#cfn-iotsitewise-accesspolicy-portal-id

ProjectProperty

class CfnAccessPolicyPropsMixin.ProjectProperty(*, id=None)

Bases: object

Identifies a specific AWS IoT SiteWise Monitor project.

Parameters:: id (Optional[str]) – The ID of the project.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-project.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

project_property = iotsitewise_mixins.CfnAccessPolicyPropsMixin.ProjectProperty(
    id="id"
)

Attributes

id

The ID of the project.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-project.html#cfn-iotsitewise-accesspolicy-project-id

UserProperty

class CfnAccessPolicyPropsMixin.UserProperty(*, id=None)

Bases: object

Contains information for a user identity in an access policy.

Parameters:: id (Optional[str]) – The IAM Identity Center ID of the user.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

user_property = iotsitewise_mixins.CfnAccessPolicyPropsMixin.UserProperty(
    id="id"
)

Attributes

id

The IAM Identity Center ID of the user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html#cfn-iotsitewise-accesspolicy-user-id