You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTSiteWise::Types::CreateAccessPolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateAccessPolicyRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  access_policy_identity: { # required
    user: {
      id: "IdentityId", # required
    },
    group: {
      id: "IdentityId", # required
    },
    iam_user: {
      arn: "ARN", # required
    },
  },
  access_policy_resource: { # required
    portal: {
      id: "ID", # required
    },
    project: {
      id: "ID", # required
    },
  },
  access_policy_permission: "ADMINISTRATOR", # required, accepts ADMINISTRATOR, VIEWER
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_policy_identity ⇒ Types::Identity

The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.

Returns:

#access_policy_permission ⇒ String

The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

Possible values:

  • ADMINISTRATOR
  • VIEWER

Returns:

  • (String) —

    The permission level for this access policy.

#access_policy_resource ⇒ Types::Resource

The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

Returns:

  • (Types::Resource) —

    The AWS IoT SiteWise Monitor resource for this access policy.

#client_token ⇒ String

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don\'t reuse this client token if a new idempotent request is required.

Returns:

  • (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

#tags ⇒ Hash<String,String>

A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Returns:

  • (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the access policy.