You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Pinpoint::Types::APNSChannelRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass APNSChannelRequest data as a hash:

{
  bundle_id: "__string",
  certificate: "__string",
  default_authentication_method: "__string",
  enabled: false,
  private_key: "__string",
  team_id: "__string",
  token_key: "__string",
  token_key_id: "__string",
}

Apple Push Notification Service channel definition.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The bundle id used for APNs Tokens.

Returns:

  • (String)


287
288
289
290
291
292
293
294
295
296
297
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 287

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#certificateString

The distribution certificate from Apple.

Returns:

  • (String)


287
288
289
290
291
292
293
294
295
296
297
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 287

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#default_authentication_methodString

The default authentication method used for APNs.

Returns:

  • (String)


287
288
289
290
291
292
293
294
295
296
297
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 287

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#enabledBoolean

If the channel is enabled for sending messages.

Returns:

  • (Boolean)


287
288
289
290
291
292
293
294
295
296
297
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 287

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#private_keyString

The certificate private key.

Returns:

  • (String)


287
288
289
290
291
292
293
294
295
296
297
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 287

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#team_idString

The team id used for APNs Tokens.

Returns:

  • (String)


287
288
289
290
291
292
293
294
295
296
297
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 287

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#token_keyString

The token key used for APNs Tokens.

Returns:

  • (String)


287
288
289
290
291
292
293
294
295
296
297
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 287

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#token_key_idString

The token key used for APNs Tokens.

Returns:

  • (String)


287
288
289
290
291
292
293
294
295
296
297
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 287

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end