Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. appsync
  5. ChannelNamespace

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.appsync.ChannelNamespace

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AppSync ChannelNamespace

Create ChannelNamespace Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ChannelNamespace(name: string, args: ChannelNamespaceArgs, opts?: CustomResourceOptions);
@overload
def ChannelNamespace(resource_name: str,
                     args: ChannelNamespaceArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ChannelNamespace(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     api_id: Optional[str] = None,
                     code_handlers: Optional[str] = None,
                     code_s3_location: Optional[str] = None,
                     name: Optional[str] = None,
                     publish_auth_modes: Optional[Sequence[ChannelNamespaceAuthModeArgs]] = None,
                     subscribe_auth_modes: Optional[Sequence[ChannelNamespaceAuthModeArgs]] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewChannelNamespace(ctx *Context, name string, args ChannelNamespaceArgs, opts ...ResourceOption) (*ChannelNamespace, error)
public ChannelNamespace(string name, ChannelNamespaceArgs args, CustomResourceOptions? opts = null)
public ChannelNamespace(String name, ChannelNamespaceArgs args)
public ChannelNamespace(String name, ChannelNamespaceArgs args, CustomResourceOptions options)

type: aws-native:appsync:ChannelNamespace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ChannelNamespaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ChannelNamespaceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ChannelNamespaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ChannelNamespaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ChannelNamespaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ChannelNamespace Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ChannelNamespace resource accepts the following input properties:

ApiId This property is required. string
AppSync Api Id that this Channel Namespace belongs to.
CodeHandlers string
The event handler functions that run custom business logic to process published events and subscribe requests.
CodeS3Location string
The Amazon S3 endpoint where the code is located.
Name string
The name of the channel namespace. This name must be unique within the Api .
PublishAuthModes List<Pulumi.AwsNative.AppSync.Inputs.ChannelNamespaceAuthMode>
List of AuthModes supported for Publish operations.
SubscribeAuthModes List<Pulumi.AwsNative.AppSync.Inputs.ChannelNamespaceAuthMode>
List of AuthModes supported for Subscribe operations.
Tags List<Pulumi.AwsNative.Inputs.Tag>
A set of tags (key-value pairs) for this channel namespace.
ApiId This property is required. string
AppSync Api Id that this Channel Namespace belongs to.
CodeHandlers string
The event handler functions that run custom business logic to process published events and subscribe requests.
CodeS3Location string
The Amazon S3 endpoint where the code is located.
Name string
The name of the channel namespace. This name must be unique within the Api .
PublishAuthModes []ChannelNamespaceAuthModeArgs
List of AuthModes supported for Publish operations.
SubscribeAuthModes []ChannelNamespaceAuthModeArgs
List of AuthModes supported for Subscribe operations.
Tags TagArgs
A set of tags (key-value pairs) for this channel namespace.
apiId This property is required. String
AppSync Api Id that this Channel Namespace belongs to.
codeHandlers String
The event handler functions that run custom business logic to process published events and subscribe requests.
codeS3Location String
The Amazon S3 endpoint where the code is located.
name String
The name of the channel namespace. This name must be unique within the Api .
publishAuthModes List<ChannelNamespaceAuthMode>
List of AuthModes supported for Publish operations.
subscribeAuthModes List<ChannelNamespaceAuthMode>
List of AuthModes supported for Subscribe operations.
tags List<Tag>
A set of tags (key-value pairs) for this channel namespace.
apiId This property is required. string
AppSync Api Id that this Channel Namespace belongs to.
codeHandlers string
The event handler functions that run custom business logic to process published events and subscribe requests.
codeS3Location string
The Amazon S3 endpoint where the code is located.
name string
The name of the channel namespace. This name must be unique within the Api .
publishAuthModes ChannelNamespaceAuthMode[]
List of AuthModes supported for Publish operations.
subscribeAuthModes ChannelNamespaceAuthMode[]
List of AuthModes supported for Subscribe operations.
tags Tag[]
A set of tags (key-value pairs) for this channel namespace.
api_id This property is required. str
AppSync Api Id that this Channel Namespace belongs to.
code_handlers str
The event handler functions that run custom business logic to process published events and subscribe requests.
code_s3_location str
The Amazon S3 endpoint where the code is located.
name str
The name of the channel namespace. This name must be unique within the Api .
publish_auth_modes Sequence[ChannelNamespaceAuthModeArgs]
List of AuthModes supported for Publish operations.
subscribe_auth_modes Sequence[ChannelNamespaceAuthModeArgs]
List of AuthModes supported for Subscribe operations.
tags Sequence[TagArgs]
A set of tags (key-value pairs) for this channel namespace.
apiId This property is required. String
AppSync Api Id that this Channel Namespace belongs to.
codeHandlers String
The event handler functions that run custom business logic to process published events and subscribe requests.
codeS3Location String
The Amazon S3 endpoint where the code is located.
name String
The name of the channel namespace. This name must be unique within the Api .
publishAuthModes List<Property Map>
List of AuthModes supported for Publish operations.
subscribeAuthModes List<Property Map>
List of AuthModes supported for Subscribe operations.
tags List<Property Map>
A set of tags (key-value pairs) for this channel namespace.

Outputs

All input properties are implicitly available as output properties. Additionally, the ChannelNamespace resource produces the following output properties:

ChannelNamespaceArn string
The Amazon Resource Name (ARN) of the channel namespace.
Id string
The provider-assigned unique ID for this managed resource.
ChannelNamespaceArn string
The Amazon Resource Name (ARN) of the channel namespace.
Id string
The provider-assigned unique ID for this managed resource.
channelNamespaceArn String
The Amazon Resource Name (ARN) of the channel namespace.
id String
The provider-assigned unique ID for this managed resource.
channelNamespaceArn string
The Amazon Resource Name (ARN) of the channel namespace.
id string
The provider-assigned unique ID for this managed resource.
channel_namespace_arn str
The Amazon Resource Name (ARN) of the channel namespace.
id str
The provider-assigned unique ID for this managed resource.
channelNamespaceArn String
The Amazon Resource Name (ARN) of the channel namespace.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ChannelNamespaceAuthMode
, ChannelNamespaceAuthModeArgs

ChannelNamespaceAuthenticationType
, ChannelNamespaceAuthenticationTypeArgs

AmazonCognitoUserPools
AMAZON_COGNITO_USER_POOLS
AwsIam
AWS_IAM
ApiKey
API_KEY
OpenidConnect
OPENID_CONNECT
AwsLambda
AWS_LAMBDA
ChannelNamespaceAuthenticationTypeAmazonCognitoUserPools
AMAZON_COGNITO_USER_POOLS
ChannelNamespaceAuthenticationTypeAwsIam
AWS_IAM
ChannelNamespaceAuthenticationTypeApiKey
API_KEY
ChannelNamespaceAuthenticationTypeOpenidConnect
OPENID_CONNECT
ChannelNamespaceAuthenticationTypeAwsLambda
AWS_LAMBDA
AmazonCognitoUserPools
AMAZON_COGNITO_USER_POOLS
AwsIam
AWS_IAM
ApiKey
API_KEY
OpenidConnect
OPENID_CONNECT
AwsLambda
AWS_LAMBDA
AmazonCognitoUserPools
AMAZON_COGNITO_USER_POOLS
AwsIam
AWS_IAM
ApiKey
API_KEY
OpenidConnect
OPENID_CONNECT
AwsLambda
AWS_LAMBDA
AMAZON_COGNITO_USER_POOLS
AMAZON_COGNITO_USER_POOLS
AWS_IAM
AWS_IAM
API_KEY
API_KEY
OPENID_CONNECT
OPENID_CONNECT
AWS_LAMBDA
AWS_LAMBDA
"AMAZON_COGNITO_USER_POOLS"
AMAZON_COGNITO_USER_POOLS
"AWS_IAM"
AWS_IAM
"API_KEY"
API_KEY
"OPENID_CONNECT"
OPENID_CONNECT
"AWS_LAMBDA"
AWS_LAMBDA

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native