platform_application_attributes

Creates, updates, deletes, gets or lists a platform_application_attributes resource.

Overview

Name	platform_application_attributes
Type	Resource
Id	aws.sns.platform_application_attributes

Fields

The following fields are returned by SELECT queries:

get_platform_application_attributes

Name	Datatype	Description
attributes	string	Attributes include the following: AppleCertificateExpiryDate – The expiry date of the SSL certificate used to configure certificate-based authentication. ApplePlatformTeamID – The Apple developer account ID used to configure token-based authentication. ApplePlatformBundleID – The app identifier used to configure token-based authentication. AuthenticationMethod – Returns the credential type used when sending push notifications from application to APNS/APNS_Sandbox, or application to GCM. APNS – Returns the token or certificate. GCM – Returns the token or key. EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent. EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent. EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent. EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_platform_application_attributes	select	PlatformApplicationArn, region		Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
set_platform_application_attributes	update	PlatformApplicationArn, region	Attributes	Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
PlatformApplicationArn	string	PlatformApplicationArn for SetPlatformApplicationAttributes action.
region	string	AWS region (default: us-east-1)
Attributes	object	A map of the platform application attributes. Attributes in this map include the following: PlatformCredential – The credential received from the notification service. For ADM, PlatformCredentialis 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. The PlatformCredential is API key. For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential 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, PlatformPrincipalis 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.

SELECT examples

get_platform_application_attributes

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

SELECT
attributes
FROM aws.sns.platform_application_attributes
WHERE PlatformApplicationArn = '{{ PlatformApplicationArn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

set_platform_application_attributes

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

UPDATE aws.sns.platform_application_attributes
SET 
-- No updatable properties
WHERE 
PlatformApplicationArn = '{{ PlatformApplicationArn }}' --required
AND region = '{{ region }}' --required
AND Attributes = '{{ Attributes}}';