Package software.amazon.awssdk.services.sns.model

Interface SetPlatformApplicationAttributesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SetPlatformApplicationAttributesRequest.Builder,SetPlatformApplicationAttributesRequest>, SdkBuilder<SetPlatformApplicationAttributesRequest.Builder,SetPlatformApplicationAttributesRequest>, SdkPojo, SdkRequest.Builder, SnsRequest.Builder
Enclosing class:
SetPlatformApplicationAttributesRequest
public static interface SetPlatformApplicationAttributesRequest.Builder extends SnsRequest.Builder, SdkPojo, CopyableBuilder<SetPlatformApplicationAttributesRequest.Builder,SetPlatformApplicationAttributesRequest>

  • Method Details

    • platformApplicationArn

      SetPlatformApplicationAttributesRequest.Builder platformApplicationArn(String platformApplicationArn)

      PlatformApplicationArn for SetPlatformApplicationAttributes action.

      Parameters:
      platformApplicationArn - PlatformApplicationArn for SetPlatformApplicationAttributes action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      SetPlatformApplicationAttributesRequest.Builder attributes(Map<String,String> attributes)

      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.

      Parameters:
      attributes - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SetPlatformApplicationAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SetPlatformApplicationAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.