Class: Aws::SNS::Types::SetPlatformApplicationAttributesInput

Inherits:

Struct

Object
Struct
Aws::SNS::Types::SetPlatformApplicationAttributesInput

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-sns/types.rb

Overview

Input for SetPlatformApplicationAttributes action.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attributes ⇒ Hash<String,String>

A map of the platform application attributes.
#platform_application_arn ⇒ String

PlatformApplicationArn for SetPlatformApplicationAttributes action.

Instance Attribute Details

#attributes ⇒ `Hash<String,String>`

A map of the platform application attributes. Attributes in this map include the following:

‘PlatformCredential` – The credential received from the notification service.
- For ADM, ‘PlatformCredential`is client secret.
- For Apple Services using certificate credentials, ‘PlatformCredential` is private key.
- For Apple Services using token credentials, ‘PlatformCredential` is signing key.
- For GCM (Firebase Cloud Messaging), ‘PlatformCredential` is API key.

‘PlatformPrincipal` – The principal received from the notification service.
- For ADM, ‘PlatformPrincipal`is client id.
- For Apple Services using certificate credentials, ‘PlatformPrincipal` is SSL certificate.
- For Apple Services using token credentials, ‘PlatformPrincipal` is signing key ID.
- For GCM (Firebase Cloud Messaging), there is no ‘PlatformPrincipal`.

‘EventEndpointCreated` – Topic ARN to which `EndpointCreated` event notifications are sent.
‘EventEndpointDeleted` – Topic ARN to which `EndpointDeleted` event notifications are sent.
‘EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event notifications are sent.
‘EventDeliveryFailure` – Topic ARN to which `DeliveryFailure` event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application’s endpoints.
‘SuccessFeedbackRoleArn` – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
‘FailureFeedbackRoleArn` – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
‘SuccessFeedbackSampleRate` – Sample rate percentage (0-100) of successfully delivered messages.

The following attributes only apply to ‘APNs` token-based authentication:

‘ApplePlatformTeamID` – The identifier that’s assigned to your Apple developer account team.
‘ApplePlatformBundleID` – The bundle identifier that’s assigned to your iOS app.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-sns/types.rb', line 2271

class SetPlatformApplicationAttributesInput < Struct.new(
  :platform_application_arn,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#platform_application_arn ⇒ `String`

PlatformApplicationArn for SetPlatformApplicationAttributes action.