Class: Aws::Pinpoint::Types::APNSVoipSandboxChannelRequest

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::APNSVoipSandboxChannelRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass APNSVoipSandboxChannelRequest 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",
}

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #bundle_id ⇒ String

  The bundle identifier that’s assigned to your iOS app.

• #certificate ⇒ String

  The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

• #default_authentication_method ⇒ String

  The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

• #enabled ⇒ Boolean

  Specifies whether the APNs VoIP sandbox channel is enabled for the application.

• #private_key ⇒ String

  The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

• #team_id ⇒ String

  The identifier that’s assigned to your Apple developer account team.

• #token_key ⇒ String

  The authentication key to use for APNs tokens.

• #token_key_id ⇒ String

  The key identifier that’s assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

Instance Attribute Details

#bundle_id ⇒ String

The bundle identifier that’s assigned to your iOS app. This identifier is used for APNs tokens.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1116

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

#certificate ⇒ String

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1116

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

#default_authentication_method ⇒ String

The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1116

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

#enabled ⇒ Boolean

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1116

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

#private_key ⇒ String

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1116

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

#team_id ⇒ String

The identifier that’s assigned to your Apple developer account team. This identifier is used for APNs tokens.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1116

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

#token_key ⇒ String

The authentication key to use for APNs tokens.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1116

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

#token_key_id ⇒ String

The key identifier that’s assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1116

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