Package com.pulumi.aws.pinpoint

Class GcmChannel

  • public class GcmChannel
extends com.pulumi.resources.CustomResource
    Provides an End User Messaging GCM Channel resource. > **Note:** Credentials (Service Account JSON and API Key) will be stored in the raw state as plain-text. ## Import Using `pulumi import`, import End User Messaging GCM Channel using the `application-id`. For example: ```sh $ pulumi import aws:pinpoint/gcmChannel:GcmChannel gcm 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.util.Optional<java.lang.String>> apiKey()  
      com.pulumi.core.Output<java.lang.String> applicationId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultAuthenticationMethod()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()  
      static GcmChannel get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, GcmChannelState 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.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> serviceJson()  

      • 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

      • GcmChannel

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

      • GcmChannel

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

      • GcmChannel

        public GcmChannel​(java.lang.String name,
                  GcmChannelArgs 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

      • apiKey

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> apiKey()
        Returns:
        Platform credential API key from Google. Conflicts with `serviceJson`.

      • applicationId

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

      • defaultAuthenticationMethod

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultAuthenticationMethod()
        Returns:
        Default authentication method used for GCM. Valid values: `KEY`, `TOKEN`. Defaults to `KEY`.

      • enabled

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

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

      • serviceJson

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> serviceJson()
        Returns:
        Service Account JSON from Google to use with the GCM API. Conflicts with `apiKey`.

      • get

        public static GcmChannel get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             GcmChannelState 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.