Class: Aws::ChimeSDKMessaging::Types::CreateChannelRequest

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

Overview

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#app_instance_arnString

The ARN of the channel request.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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_idString

The ID of the channel in the request.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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_bearerString

The ARN of the ‘AppInstanceUser` or `AppInstanceBot` that makes the API call.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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_tokenString

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)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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_configurationTypes::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 '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_settingsTypes::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 '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_arnsArray<String>

The ARNs of the channel members in the request.

Returns:

  • (Array<String>)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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

#metadataString

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

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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

#modeString

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)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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_arnsArray<String>

The ARNs of the channel moderators in the request.

Returns:

  • (Array<String>)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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

#nameString

The name of the channel.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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

#privacyString

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)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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

#tagsArray<Types::Tag>

The tags for the creation request.

Returns:



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '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