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 Summary

Modifier and Type	Method and Description
SetPlatformApplicationAttributesRequest.Builder	attributes(Map<String,String> attributes) A map of the platform application attributes.
SetPlatformApplicationAttributesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SetPlatformApplicationAttributesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SetPlatformApplicationAttributesRequest.Builder	platformApplicationArn(String platformApplicationArn) PlatformApplicationArn for SetPlatformApplicationAttributes action.

Methods inherited from interface software.amazon.awssdk.services.sns.model.SnsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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), PlatformCredential is API key.

• 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), PlatformCredential is API key.

• 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

SetPlatformApplicationAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder