Package com.pulumi.aws.pinpoint

Class ApnsVoipChannel

  • public class ApnsVoipChannel
extends com.pulumi.resources.CustomResource
    Provides an End User Messaging APNs VoIP Channel resource. > **Note:** All arguments, including certificates and tokens, will be stored in the raw state as plain-text. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.pinpoint.App;
 import com.pulumi.aws.pinpoint.ApnsVoipChannel;
 import com.pulumi.aws.pinpoint.ApnsVoipChannelArgs;
 import com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.FileArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var app = new App("app");
 
         var apnsVoip = new ApnsVoipChannel("apnsVoip", ApnsVoipChannelArgs.builder()
             .applicationId(app.applicationId())
             .certificate(StdFunctions.file(FileArgs.builder()
                 .input("./certificate.pem")
                 .build()).result())
             .privateKey(StdFunctions.file(FileArgs.builder()
                 .input("./private_key.key")
                 .build()).result())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import End User Messaging APNs VoIP Channel using the `application-id`. For example: ```sh $ pulumi import aws:pinpoint/apnsVoipChannel:ApnsVoipChannel apns_voip application-id ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> applicationId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> bundleId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificate()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultAuthenticationMethod()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()  
      static ApnsVoipChannel get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ApnsVoipChannelState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> privateKey()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> teamId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> tokenKey()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> tokenKeyId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ApnsVoipChannel

        public ApnsVoipChannel​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ApnsVoipChannel

        public ApnsVoipChannel​(java.lang.String name,
                       ApnsVoipChannelArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ApnsVoipChannel

        public ApnsVoipChannel​(java.lang.String name,
                       ApnsVoipChannelArgs args,
                       @Nullable
                       com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • applicationId

        public com.pulumi.core.Output<java.lang.String> applicationId()
        Returns:
        Application ID.

      • bundleId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> bundleId()
        Returns:
        ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.

      • certificate

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificate()
        Returns:
        Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.

      • defaultAuthenticationMethod

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultAuthenticationMethod()
        Returns:
        Default authentication method used for APNs. __NOTE__: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.

      • enabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()
        Returns:
        Whether the channel is enabled or disabled. Defaults to `true`.

      • privateKey

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> privateKey()
        Returns:
        Certificate Private Key file (ie. `.key` file). Required if using Certificate credentials.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • teamId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> teamId()
        Returns:
        ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.

      • tokenKey

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> tokenKey()
        Returns:
        `.p8` file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.

      • tokenKeyId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> tokenKeyId()
        Returns:
        ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.

      • get

        public static ApnsVoipChannel get​(java.lang.String name,
                                  com.pulumi.core.Output<java.lang.String> id,
                                  @Nullable
                                  ApnsVoipChannelState state,
                                  @Nullable
                                  com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.