CfnAccessPolicy

class aws_cdk.aws_iotsitewise.CfnAccessPolicy(scope, id, *, access_policy_identity, access_policy_permission, access_policy_resource)

Bases: aws_cdk.core.CfnResource

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.

CloudformationResource

AWS::IoTSiteWise::AccessPolicy

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_access_policy = iotsitewise.CfnAccessPolicy(self, "MyCfnAccessPolicy",
    access_policy_identity=iotsitewise.CfnAccessPolicy.AccessPolicyIdentityProperty(
        iam_role=iotsitewise.CfnAccessPolicy.IamRoleProperty(
            arn="arn"
        ),
        iam_user=iotsitewise.CfnAccessPolicy.IamUserProperty(
            arn="arn"
        ),
        user=iotsitewise.CfnAccessPolicy.UserProperty(
            id="id"
        )
    ),
    access_policy_permission="accessPolicyPermission",
    access_policy_resource=iotsitewise.CfnAccessPolicy.AccessPolicyResourceProperty(
        portal=iotsitewise.CfnAccessPolicy.PortalProperty(
            id="id"
        ),
        project=iotsitewise.CfnAccessPolicy.ProjectProperty(
            id="id"
        )
    )
)

Create a new AWS::IoTSiteWise::AccessPolicy.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • access_policy_identity (Union[AccessPolicyIdentityProperty, IResolvable]) – The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.

  • access_policy_permission (str) – 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.

  • access_policy_resource (Union[IResolvable, AccessPolicyResourceProperty]) – The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoTSiteWise::AccessPolicy'
access_policy_identity

The identity for this access policy.

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

Link

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

Return type

Union[AccessPolicyIdentityProperty, IResolvable]

access_policy_permission

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.

Link

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

Return type

str

access_policy_resource

The AWS IoT SiteWise Monitor resource for this access policy.

Choose either a portal or a project.

Link

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

Return type

Union[IResolvable, AccessPolicyResourceProperty]

attr_access_policy_arn

//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}

CloudformationAttribute

AccessPolicyArn

Type

The `ARN <https

Return type

str

attr_access_policy_id

The ID of the access policy.

CloudformationAttribute

AccessPolicyId

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AccessPolicyIdentityProperty

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

Bases: object

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

Parameters
Link

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.
import aws_cdk.aws_iotsitewise as iotsitewise

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

Attributes

iam_role

An IAM role identity.

Link

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

Return type

Union[IResolvable, IamRoleProperty, None]

iam_user

An IAM user identity.

Link

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

Return type

Union[IResolvable, IamUserProperty, None]

user

The AWS SSO user to which this access policy maps.

Link

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

Return type

Union[IResolvable, UserProperty, None]

AccessPolicyResourceProperty

class CfnAccessPolicy.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
Link

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.
import aws_cdk.aws_iotsitewise as iotsitewise

access_policy_resource_property = iotsitewise.CfnAccessPolicy.AccessPolicyResourceProperty(
    portal=iotsitewise.CfnAccessPolicy.PortalProperty(
        id="id"
    ),
    project=iotsitewise.CfnAccessPolicy.ProjectProperty(
        id="id"
    )
)

Attributes

portal

The AWS IoT SiteWise Monitor portal for this access policy.

Link

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

Return type

Union[IResolvable, PortalProperty, None]

project

The AWS IoT SiteWise Monitor project for this access policy.

Link

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

Return type

Union[IResolvable, ProjectProperty, None]

IamRoleProperty

class CfnAccessPolicy.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 .

Link

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.
import aws_cdk.aws_iotsitewise as iotsitewise

iam_role_property = iotsitewise.CfnAccessPolicy.IamRoleProperty(
    arn="arn"
)

Attributes

arn

The ARN of the IAM role.

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

Link

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

Return type

Optional[str]

IamUserProperty

class CfnAccessPolicy.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.

Link

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.
import aws_cdk.aws_iotsitewise as iotsitewise

iam_user_property = iotsitewise.CfnAccessPolicy.IamUserProperty(
    arn="arn"
)

Attributes

arn

//docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html>`_ 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.

Link

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

Type

The ARN of the IAM user. For more information, see `IAM ARNs <https

Return type

Optional[str]

PortalProperty

class CfnAccessPolicy.PortalProperty(*, id=None)

Bases: object

The Portal property type specifies the AWS IoT SiteWise Monitor portal for an AWS::IoTSiteWise::AccessPolicy .

Parameters

id (Optional[str]) – The ID of the portal.

Link

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.
import aws_cdk.aws_iotsitewise as iotsitewise

portal_property = iotsitewise.CfnAccessPolicy.PortalProperty(
    id="id"
)

Attributes

id

The ID of the portal.

Link

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

Return type

Optional[str]

ProjectProperty

class CfnAccessPolicy.ProjectProperty(*, id=None)

Bases: object

The Project property type specifies the AWS IoT SiteWise Monitor project for an AWS::IoTSiteWise::AccessPolicy .

Parameters

id (Optional[str]) – The ID of the project.

Link

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.
import aws_cdk.aws_iotsitewise as iotsitewise

project_property = iotsitewise.CfnAccessPolicy.ProjectProperty(
    id="id"
)

Attributes

id

The ID of the project.

Link

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

Return type

Optional[str]

UserProperty

class CfnAccessPolicy.UserProperty(*, id=None)

Bases: object

The User property type specifies the AWS IoT SiteWise Monitor user for an AWS::IoTSiteWise::AccessPolicy .

Parameters

id (Optional[str]) – The ID of the user.

Link

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.
import aws_cdk.aws_iotsitewise as iotsitewise

user_property = iotsitewise.CfnAccessPolicy.UserProperty(
    id="id"
)

Attributes

id

The ID of the user.

Link

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

Return type

Optional[str]