software.amazon.awscdk.services.pinpoint

Interface CfnAPNSVoipSandboxChannelProps

All Known Implementing Classes:

CfnAPNSVoipSandboxChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.149Z")
public interface CfnAPNSVoipSandboxChannelProps

Properties for defining a `CfnAPNSVoipSandboxChannel`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 CfnAPNSVoipSandboxChannelProps cfnAPNSVoipSandboxChannelProps = CfnAPNSVoipSandboxChannelProps.builder()
         .applicationId("applicationId")
         // the properties below are optional
         .bundleId("bundleId")
         .certificate("certificate")
         .defaultAuthenticationMethod("defaultAuthenticationMethod")
         .enabled(false)
         .privateKey("privateKey")
         .teamId("teamId")
         .tokenKey("tokenKey")
         .tokenKeyId("tokenKeyId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAPNSVoipSandboxChannelProps.Builder A builder for CfnAPNSVoipSandboxChannelProps
static class	CfnAPNSVoipSandboxChannelProps.Jsii$Proxy An implementation for CfnAPNSVoipSandboxChannelProps

Method Summary

Modifier and Type	Method and Description
static CfnAPNSVoipSandboxChannelProps.Builder	builder()
java.lang.String	getApplicationId() The unique identifier for the application that the APNs VoIP sandbox channel applies to.
default java.lang.String	getBundleId() The bundle identifier that's assigned to your iOS app.
default java.lang.String	getCertificate() The APNs client certificate that you received from Apple.
default java.lang.String	getDefaultAuthenticationMethod() The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
default java.lang.Object	getEnabled() Specifies whether the APNs VoIP sandbox channel is enabled for the application.
default java.lang.String	getPrivateKey() The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
default java.lang.String	getTeamId() The identifier that's assigned to your Apple developer account team.
default java.lang.String	getTokenKey() The authentication key to use for APNs tokens.
default java.lang.String	getTokenKeyId() The key identifier that's assigned to your APNs signing key.

Method Detail

getApplicationId

java.lang.String getApplicationId()

The unique identifier for the application that the APNs VoIP sandbox channel applies to.

getBundleId

default java.lang.String getBundleId()

The bundle identifier that's assigned to your iOS app.

This identifier is used for APNs tokens.

getCertificate

default java.lang.String getCertificate()

The APNs client certificate that you received from Apple.

Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

getDefaultAuthenticationMethod

default java.lang.String getDefaultAuthenticationMethod()

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.

Valid options are key or certificate .

getEnabled

default java.lang.Object getEnabled()

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

getPrivateKey

default java.lang.String getPrivateKey()

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

getTeamId

default java.lang.String getTeamId()

The identifier that's assigned to your Apple developer account team.

This identifier is used for APNs tokens.

getTokenKey

default java.lang.String getTokenKey()

The authentication key to use for APNs tokens.

getTokenKeyId

default java.lang.String getTokenKeyId()

The key identifier that's assigned to your APNs signing key.

Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

builder

static CfnAPNSVoipSandboxChannelProps.Builder builder()

Returns:

a CfnAPNSVoipSandboxChannelProps.Builder of CfnAPNSVoipSandboxChannelProps