AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::Chime::Types::CreateChannelRequest

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

Overview

Note:

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

{
  app_instance_arn: "ChimeArn", # required
  name: "NonEmptyResourceName", # required
  mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
  privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#app_instance_arnString

The ARN of the channel request.

Returns:

  • (String)

    The ARN of the channel request.

#client_request_tokenString

The client token for the request. An Idempotency token.

Returns:

  • (String)

    The client token for the request.

#metadataString

The metadata of the creation request. Limited to 1KB and UTF-8.

Returns:

  • (String)

    The metadata of the creation request.

#modeString

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

Possible values:

  • UNRESTRICTED
  • RESTRICTED

Returns:

  • (String)

    The channel mode: UNRESTRICTED or RESTRICTED.

#nameString

The name of the channel.

Returns:

  • (String)

    The name of the channel.

#privacyString

The channel\'s privacy level: PUBLIC or PRIVATE. Private channels aren\'t discoverable by users outside the channel. Public channels are discoverable by anyone in the app instance.

Possible values:

  • PUBLIC
  • PRIVATE

Returns:

  • (String)

    The channel\'s privacy level: PUBLIC or PRIVATE.

#tagsArray<Types::Tag>

Returns: