1. Packages
  2. AWS Native
  3. API Docs
  4. kinesisvideo
  5. SignalingChannel

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.kinesisvideo.SignalingChannel

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    Resource Type Definition for AWS::KinesisVideo::SignalingChannel

    Create SignalingChannel Resource

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

    Constructor syntax

    new SignalingChannel(name: string, args?: SignalingChannelArgs, opts?: CustomResourceOptions);
    @overload
    def SignalingChannel(resource_name: str,
                         args: Optional[SignalingChannelArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def SignalingChannel(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         message_ttl_seconds: Optional[int] = None,
                         name: Optional[str] = None,
                         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                         type: Optional[SignalingChannelType] = None)
    func NewSignalingChannel(ctx *Context, name string, args *SignalingChannelArgs, opts ...ResourceOption) (*SignalingChannel, error)
    public SignalingChannel(string name, SignalingChannelArgs? args = null, CustomResourceOptions? opts = null)
    public SignalingChannel(String name, SignalingChannelArgs args)
    public SignalingChannel(String name, SignalingChannelArgs args, CustomResourceOptions options)
    
    type: aws-native:kinesisvideo:SignalingChannel
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const signalingChannelResource = new aws_native.kinesisvideo.SignalingChannel("signalingChannelResource", {
        messageTtlSeconds: 0,
        name: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        type: aws_native.kinesisvideo.SignalingChannelType.SingleMaster,
    });
    
    Coming soon!
    

    SignalingChannel Resource Properties

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

    Inputs

    The SignalingChannel resource accepts the following input properties:

    MessageTtlSeconds int
    The period of time a signaling channel retains undelivered messages before they are discarded.
    Name string
    The name of the Kinesis Video Signaling Channel.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    Type Pulumi.AwsNative.KinesisVideo.SignalingChannelType
    The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
    MessageTtlSeconds int
    The period of time a signaling channel retains undelivered messages before they are discarded.
    Name string
    The name of the Kinesis Video Signaling Channel.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    Type SignalingChannelType
    The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
    messageTtlSeconds Integer
    The period of time a signaling channel retains undelivered messages before they are discarded.
    name String
    The name of the Kinesis Video Signaling Channel.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    type SignalingChannelType
    The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
    messageTtlSeconds number
    The period of time a signaling channel retains undelivered messages before they are discarded.
    name string
    The name of the Kinesis Video Signaling Channel.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    type SignalingChannelType
    The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
    message_ttl_seconds int
    The period of time a signaling channel retains undelivered messages before they are discarded.
    name str
    The name of the Kinesis Video Signaling Channel.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    type SignalingChannelType
    The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
    messageTtlSeconds Number
    The period of time a signaling channel retains undelivered messages before they are discarded.
    name String
    The name of the Kinesis Video Signaling Channel.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    type "SINGLE_MASTER"
    The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    SignalingChannelType, SignalingChannelTypeArgs

    SingleMaster
    SINGLE_MASTER
    SignalingChannelTypeSingleMaster
    SINGLE_MASTER
    SingleMaster
    SINGLE_MASTER
    SingleMaster
    SINGLE_MASTER
    SINGLE_MASTER
    SINGLE_MASTER
    "SINGLE_MASTER"
    SINGLE_MASTER

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi