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

Inherits:

Struct

• Object
• Struct
• Aws::Chime::Types::CreateChannelRequest

Defined in:

gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :metadata, :client_request_token]

Instance Attribute Summary

• #app_instance_arn ⇒ String

  The ARN of the channel request.

• #chime_bearer ⇒ String

  The AppInstanceUserArn of the user that makes the API call.

• #client_request_token ⇒ String

  The client token for the request.

• #metadata ⇒ String

  The metadata of the creation request.

• #mode ⇒ String

  The channel mode: UNRESTRICTED or RESTRICTED.

• #name ⇒ String

  The name of the channel.

• #privacy ⇒ String

  The channel's privacy level: PUBLIC or PRIVATE.

• #tags ⇒ Array<Types::Tag>

  The tags for the creation request.

Instance Attribute Details

#app_instance_arn ⇒ String

The ARN of the channel request.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1972

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#chime_bearer ⇒ String

The AppInstanceUserArn of the user that makes the API call.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1972

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#client_request_token ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1972

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#metadata ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1972

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1972

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#name ⇒ String

The name of the channel.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1972

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#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 AppInstance.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1972

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags for the creation request.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1972

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end