Struct aws_sdk_sns::operation::create_platform_application::builders::CreatePlatformApplicationFluentBuilder

pub struct CreatePlatformApplicationFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreatePlatformApplication.

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

PlatformPrincipal and PlatformCredential are received from the notification service.

• For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.

• For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

• For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

• For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and 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`.

• For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

• For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

Implementations

impl CreatePlatformApplicationFluentBuilder

pub fn as_input(&self) -> &CreatePlatformApplicationInputBuilder

Access the CreatePlatformApplication as a reference.

pub async fn send( self ) -> Result<CreatePlatformApplicationOutput, SdkError<CreatePlatformApplicationError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreatePlatformApplicationOutput, CreatePlatformApplicationError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn name(self, input: impl Into<String>) -> Self

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

pub fn set_name(self, input: Option<String>) -> Self

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

pub fn get_name(&self) -> &Option<String>

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

pub fn platform(self, input: impl Into<String>) -> Self

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

pub fn set_platform(self, input: Option<String>) -> Self

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

pub fn get_platform(&self) -> &Option<String>

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Attributes.

To override the contents of this collection use set_attributes.

For a list of attributes, see SetPlatformApplicationAttributes .

pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self

For a list of attributes, see SetPlatformApplicationAttributes .

pub fn get_attributes(&self) -> &Option<HashMap<String, String>>

For a list of attributes, see SetPlatformApplicationAttributes .

Trait Implementations

impl Clone for CreatePlatformApplicationFluentBuilder

fn clone(&self) -> CreatePlatformApplicationFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreatePlatformApplicationFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.