Class: Aws::Chime::Types::CreateAppInstanceUserRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb

Overview

Note:

When making an API call, you may pass CreateAppInstanceUserRequest data as a hash:

{
  app_instance_arn: "ChimeArn", # required
  app_instance_user_id: "UserId", # required
  name: "UserName", # required
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[:app_instance_user_id, :name, :metadata, :client_request_token]

Instance Attribute Summary collapse

Instance Attribute Details

#app_instance_arnString

The ARN of the AppInstance request.

Returns:

  • (String)


1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1852

class CreateAppInstanceUserRequest < Struct.new(
  :app_instance_arn,
  :app_instance_user_id,
  :name,
  :metadata,
  :client_request_token,
  :tags)
  SENSITIVE = [:app_instance_user_id, :name, :metadata, :client_request_token]
  include Aws::Structure
end

#app_instance_user_idString

The user ID of the AppInstance.

Returns:

  • (String)


1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1852

class CreateAppInstanceUserRequest < Struct.new(
  :app_instance_arn,
  :app_instance_user_id,
  :name,
  :metadata,
  :client_request_token,
  :tags)
  SENSITIVE = [:app_instance_user_id, :name, :metadata, :client_request_token]
  include Aws::Structure
end

#client_request_tokenString

The token assigned to the user requesting an AppInstance.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1852

class CreateAppInstanceUserRequest < Struct.new(
  :app_instance_arn,
  :app_instance_user_id,
  :name,
  :metadata,
  :client_request_token,
  :tags)
  SENSITIVE = [:app_instance_user_id, :name, :metadata, :client_request_token]
  include Aws::Structure
end

#metadataString

The request's metadata. Limited to a 1KB string in UTF-8.

Returns:

  • (String)


1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1852

class CreateAppInstanceUserRequest < Struct.new(
  :app_instance_arn,
  :app_instance_user_id,
  :name,
  :metadata,
  :client_request_token,
  :tags)
  SENSITIVE = [:app_instance_user_id, :name, :metadata, :client_request_token]
  include Aws::Structure
end

#nameString

The user's name.

Returns:

  • (String)


1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1852

class CreateAppInstanceUserRequest < Struct.new(
  :app_instance_arn,
  :app_instance_user_id,
  :name,
  :metadata,
  :client_request_token,
  :tags)
  SENSITIVE = [:app_instance_user_id, :name, :metadata, :client_request_token]
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags assigned to the AppInstanceUser.

Returns:



1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1852

class CreateAppInstanceUserRequest < Struct.new(
  :app_instance_arn,
  :app_instance_user_id,
  :name,
  :metadata,
  :client_request_token,
  :tags)
  SENSITIVE = [:app_instance_user_id, :name, :metadata, :client_request_token]
  include Aws::Structure
end