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

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

Overview

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#app_instance_arn ⇒ String

The ARN of the channel request.



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File '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.



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File '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.



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File '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.



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File '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.



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File '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.



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File '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`.



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File '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.



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File '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