ChannelNamespace class

Manages an AWS AppSync Channel Namespace.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.appsync.ChannelNamespace("example", {
    name: "example-channel-namespace",
    apiId: exampleAwsAppsyncApi.apiId,
});
import pulumi
import pulumi_aws as aws

example = aws.appsync.ChannelNamespace("example",
    name="example-channel-namespace",
    api_id=example_aws_appsync_api["apiId"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.AppSync.ChannelNamespace("example", new()
    {
        Name = "example-channel-namespace",
        ApiId = exampleAwsAppsyncApi.ApiId,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/appsync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appsync.NewChannelNamespace(ctx, "example", &appsync.ChannelNamespaceArgs{
			Name:  pulumi.String("example-channel-namespace"),
			ApiId: pulumi.Any(exampleAwsAppsyncApi.ApiId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_appsync_channelnamespace" "example" {
  name   = "example-channel-namespace"
  api_id = exampleAwsAppsyncApi.apiId
}
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());

    }
}
resources:
  example:
    type: aws:appsync:ChannelNamespace
    properties:
      name: example-channel-namespace
      apiId: ${exampleAwsAppsyncApi.apiId}

Import

Using pulumi import, import AppSync Channel Namespace using the apiId and name separated by a comma (,). For example:

$ pulumi import aws:appsync/channelNamespace:ChannelNamespace example example-api-id,example-channel-namespace

Constructors

ChannelNamespace(String name, {ChannelNamespaceArgs? args, CustomResourceOptions? options})
Creates a new ChannelNamespace. name The Pulumi resource name. args Arguments used to configure this ChannelNamespace. The set of arguments for ChannelNamespace. options Resource options controlling this resource's behavior.
ChannelNamespace.reference(String urn)
Creates a typed reference to an existing ChannelNamespace resource.

Properties

apiId ↔ Output<String>
Event API ID.
latefinal
channelNamespaceArn ↔ Output<String>
ARN of the channel namespace.
latefinal
childResources → Set<Resource>
finalinherited
codeHandlers ↔ Output<String?>
Event handler functions that run custom business logic to process published events and subscribe requests.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
handlerConfigs ↔ Output<ChannelNamespaceHandlerConfigs?>
Configuration for the onPublish and onSubscribe handlers. See handlerConfigs below.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name of the channel namespace.
latefinal
publishAuthModes ↔ Output<List<ChannelNamespacePublishAuthMode>?>
Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See publishAuthMode below.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subscribeAuthModes ↔ Output<List<ChannelNamespaceSubscribeAuthMode>?>
Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See subscribeAuthMode below.
latefinal
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ChannelNamespaceState? state, CustomResourceOptions? options}) → ChannelNamespace
Gets an existing ChannelNamespace resource's state with the given name and id.