Class: Aws::ChimeSDKMessaging::Types::CreateChannelRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ChimeSDKMessaging::Types::CreateChannelRequest
- Defined in:
- gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:name, :metadata, :client_request_token, :channel_id]
Instance Attribute Summary collapse
-
#app_instance_arn ⇒ String
The ARN of the channel request.
-
#channel_id ⇒ String
The ID of the channel in the request.
-
#chime_bearer ⇒ String
The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call. -
#client_request_token ⇒ String
The client token for the request.
-
#elastic_channel_configuration ⇒ Types::ElasticChannelConfiguration
The attributes required to configure and create an elastic channel.
-
#expiration_settings ⇒ Types::ExpirationSettings
Settings that control the interval after which the channel is automatically deleted.
-
#member_arns ⇒ Array<String>
The ARNs of the channel members in the request.
-
#metadata ⇒ String
The metadata of the creation request.
-
#mode ⇒ String
The channel mode:
UNRESTRICTED
orRESTRICTED
. -
#moderator_arns ⇒ Array<String>
The ARNs of the channel moderators in the request.
-
#name ⇒ String
The name of the channel.
-
#privacy ⇒ String
The channel's privacy level:
PUBLIC
orPRIVATE
. -
#tags ⇒ Array<Types::Tag>
The tags for the creation request.
Instance Attribute Details
#app_instance_arn ⇒ String
The ARN of the channel request.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |
#channel_id ⇒ String
The ID of the channel in the request.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |
#chime_bearer ⇒ String
The ARN of the AppInstanceUser
or AppInstanceBot
that makes the
API call.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] 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.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |
#elastic_channel_configuration ⇒ Types::ElasticChannelConfiguration
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |
#expiration_settings ⇒ Types::ExpirationSettings
Settings that control the interval after which the channel is automatically deleted.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |
#member_arns ⇒ Array<String>
The ARNs of the channel members in the request.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |
#metadata ⇒ String
The metadata of the creation request. Limited to 1KB and UTF-8.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] 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.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |
#moderator_arns ⇒ Array<String>
The ARNs of the channel moderators in the request.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |
#name ⇒ String
The name of the channel.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] 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
.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
The tags for the creation request.
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1229 class CreateChannelRequest < Struct.new( :app_instance_arn, :name, :mode, :privacy, :metadata, :client_request_token, :tags, :chime_bearer, :channel_id, :member_arns, :moderator_arns, :elastic_channel_configuration, :expiration_settings) SENSITIVE = [:name, :metadata, :client_request_token, :channel_id] include Aws::Structure end |