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

Class: Aws::IoT::Types::TestAuthorizationRequest

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

Overview

Note:

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

{
  principal: "Principal",
  cognito_identity_pool_id: "CognitoIdentityPoolId",
  auth_infos: [ # required
    {
      action_type: "PUBLISH", # accepts PUBLISH, SUBSCRIBE, RECEIVE, CONNECT
      resources: ["Resource"],
    },
  ],
  client_id: "ClientId",
  policy_names_to_add: ["PolicyName"],
  policy_names_to_skip: ["PolicyName"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#auth_infosArray<Types::AuthInfo>

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

Returns:

#client_idString

The MQTT client ID.

Returns:

  • (String)

    The MQTT client ID.

#cognito_identity_pool_idString

The Cognito identity pool ID.

Returns:

  • (String)

    The Cognito identity pool ID.

#policy_names_to_addArray<String>

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

Returns:

  • (Array<String>)

    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

#policy_names_to_skipArray<String>

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

Returns:

  • (Array<String>)

    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

#principalString

The principal.

Returns:

  • (String)

    The principal.