Class: Aws::SNS::Types::SetPlatformApplicationAttributesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SNS::Types::SetPlatformApplicationAttributesInput
- Defined in:
- gems/aws-sdk-sns/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
forSetPlatformApplicationAttributes
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) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
.For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
. ^
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 whichEndpointCreated
event notifications are sent.EventEndpointDeleted
– Topic ARN to whichEndpointDeleted
event notifications are sent.EventEndpointUpdated
– Topic ARN to whichEndpointUpdate
event notifications are sent.EventDeliveryFailure
– Topic ARN to whichDeliveryFailure
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.
2290 2291 2292 2293 2294 2295 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2290 class SetPlatformApplicationAttributesInput < Struct.new( :platform_application_arn, :attributes) SENSITIVE = [] include Aws::Structure end |
#platform_application_arn ⇒ String
PlatformApplicationArn
for SetPlatformApplicationAttributes
action.
2290 2291 2292 2293 2294 2295 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2290 class SetPlatformApplicationAttributesInput < Struct.new( :platform_application_arn, :attributes) SENSITIVE = [] include Aws::Structure end |