class Aws::ChimeSDKMessaging::Types::CreateChannelRequest
@note When making an API call, you may pass CreateChannelRequest
data as a 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 }, ], chime_bearer: "ChimeArn", # required }
@!attribute [rw] app_instance_arn
The ARN of the channel request. @return [String]
@!attribute [rw] name
The name of the channel. @return [String]
@!attribute [rw] mode
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. @return [String]
@!attribute [rw] privacy
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 `AppInstance`. @return [String]
@!attribute [rw] metadata
The metadata of the creation request. Limited to 1KB and UTF-8. @return [String]
@!attribute [rw] client_request_token
The client token for the request. An `Idempotency` token. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] tags
The tags for the creation request. @return [Array<Types::Tag>]
@!attribute [rw] chime_bearer
The `AppInstanceUserArn` of the user that makes the API call. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelRequest AWS API Documentation
Constants
- SENSITIVE