Package com.pulumi.aws.appsync

Class ChannelNamespace

  • public class ChannelNamespace
extends com.pulumi.resources.CustomResource
    Manages an [AWS AppSync Channel Namespace](https://docs.aws.amazon.com/appsync/latest/eventapi/event-api-concepts.html#namespace). ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.appsync.ChannelNamespace;
 import com.pulumi.aws.appsync.ChannelNamespaceArgs;
 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 example = new ChannelNamespace("example", ChannelNamespaceArgs.builder()
             .name("example-channel-namespace")
             .apiId(exampleAwsAppsyncApi.apiId())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import AppSync Channel Namespace using the `apiId` and `name` separated by a comma (`,`). For example: ```sh $ pulumi import aws:appsync/channelNamespace:ChannelNamespace example example-api-id,example-channel-namespace ```

    • 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> apiId()  
      com.pulumi.core.Output<java.lang.String> channelNamespaceArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> codeHandlers()  
      static ChannelNamespace get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ChannelNamespaceState 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<ChannelNamespaceHandlerConfigs>> handlerConfigs()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<ChannelNamespacePublishAuthMode>>> publishAuthModes()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<ChannelNamespaceSubscribeAuthMode>>> subscribeAuthModes()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • 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

      • ChannelNamespace

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

      • ChannelNamespace

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

      • ChannelNamespace

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

      • apiId

        public com.pulumi.core.Output<java.lang.String> apiId()
        Returns:
        Event API ID.

      • channelNamespaceArn

        public com.pulumi.core.Output<java.lang.String> channelNamespaceArn()
        Returns:
        ARN of the channel namespace.

      • codeHandlers

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> codeHandlers()
        Returns:
        Event handler functions that run custom business logic to process published events and subscribe requests.

      • handlerConfigs

        public com.pulumi.core.Output<java.util.Optional<ChannelNamespaceHandlerConfigs>> handlerConfigs()
        Returns:
        Configuration for the `onPublish` and `onSubscribe` handlers. See `handlerConfigs` below.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the channel namespace. The following arguments are optional:

      • publishAuthModes

        public com.pulumi.core.Output<java.util.Optional<java.util.List<ChannelNamespacePublishAuthMode>>> publishAuthModes()
        Returns:
        Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See `publishAuthMode` below.

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

      • subscribeAuthModes

        public com.pulumi.core.Output<java.util.Optional<java.util.List<ChannelNamespaceSubscribeAuthMode>>> subscribeAuthModes()
        Returns:
        Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See `subscribeAuthMode` below.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

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