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
- Struct
- Aws::Chime::Types::CreateChannelRequest
- Defined in:
- (unknown)
Overview
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
-
#app_instance_arn ⇒ String
The ARN of the channel request.
-
#client_request_token ⇒ String
The client token for the request.
-
#metadata ⇒ String
The metadata of the creation request.
-
#mode ⇒ String
The channel mode:
UNRESTRICTED
orRESTRICTED
. -
#name ⇒ String
The name of the channel.
-
#privacy ⇒ String
The channel\'s privacy level:
PUBLIC
orPRIVATE
. -
#tags ⇒ Array<Types::Tag>
Instance Attribute Details
#app_instance_arn ⇒ String
The ARN of the channel request.
#client_request_token ⇒ String
The client token for the request. An Idempotency
token.
#metadata ⇒ String
The metadata of the creation request. Limited to 1KB and UTF-8.
#mode ⇒ String
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
#name ⇒ String
The name of the channel.
#privacy ⇒ String
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