1. Packages
  2. AWS
  3. API Docs
  4. ivs
  5. getStreamKey
AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi
aws-v6 logo
AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi

    Data source for managing an AWS IVS (Interactive Video) Stream Key.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.ivs.getStreamKey({
        channelArn: "arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.ivs.get_stream_key(channel_arn="arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ivs"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ivs.GetStreamKey(ctx, &ivs.GetStreamKeyArgs{
    			ChannelArn: "arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Ivs.GetStreamKey.Invoke(new()
        {
            ChannelArn = "arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ivs.IvsFunctions;
    import com.pulumi.aws.ivs.inputs.GetStreamKeyArgs;
    import java.util.List;
    import java.util.ArrayList;
    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) {
            final var example = IvsFunctions.getStreamKey(GetStreamKeyArgs.builder()
                .channelArn("arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aws:ivs:getStreamKey
          arguments:
            channelArn: arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5
    

    Using getStreamKey

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStreamKey(args: GetStreamKeyArgs, opts?: InvokeOptions): Promise<GetStreamKeyResult>
    function getStreamKeyOutput(args: GetStreamKeyOutputArgs, opts?: InvokeOptions): Output<GetStreamKeyResult>
    def get_stream_key(channel_arn: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetStreamKeyResult
    def get_stream_key_output(channel_arn: Optional[pulumi.Input[str]] = None,
                       tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetStreamKeyResult]
    func GetStreamKey(ctx *Context, args *GetStreamKeyArgs, opts ...InvokeOption) (*GetStreamKeyResult, error)
    func GetStreamKeyOutput(ctx *Context, args *GetStreamKeyOutputArgs, opts ...InvokeOption) GetStreamKeyResultOutput

    > Note: This function is named GetStreamKey in the Go SDK.

    public static class GetStreamKey 
    {
        public static Task<GetStreamKeyResult> InvokeAsync(GetStreamKeyArgs args, InvokeOptions? opts = null)
        public static Output<GetStreamKeyResult> Invoke(GetStreamKeyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStreamKeyResult> getStreamKey(GetStreamKeyArgs args, InvokeOptions options)
    public static Output<GetStreamKeyResult> getStreamKey(GetStreamKeyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws:ivs/getStreamKey:getStreamKey
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ChannelArn string
    ARN of the Channel.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    ChannelArn string
    ARN of the Channel.
    Tags map[string]string
    Map of tags assigned to the resource.
    channelArn String
    ARN of the Channel.
    tags Map<String,String>
    Map of tags assigned to the resource.
    channelArn string
    ARN of the Channel.
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    channel_arn str
    ARN of the Channel.
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    channelArn String
    ARN of the Channel.
    tags Map<String>
    Map of tags assigned to the resource.

    getStreamKey Result

    The following output properties are available:

    Arn string
    ARN of the Stream Key.
    ChannelArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    Value string
    Stream Key value.
    Arn string
    ARN of the Stream Key.
    ChannelArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Tags map[string]string
    Map of tags assigned to the resource.
    Value string
    Stream Key value.
    arn String
    ARN of the Stream Key.
    channelArn String
    id String
    The provider-assigned unique ID for this managed resource.
    tags Map<String,String>
    Map of tags assigned to the resource.
    value String
    Stream Key value.
    arn string
    ARN of the Stream Key.
    channelArn string
    id string
    The provider-assigned unique ID for this managed resource.
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    value string
    Stream Key value.
    arn str
    ARN of the Stream Key.
    channel_arn str
    id str
    The provider-assigned unique ID for this managed resource.
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    value str
    Stream Key value.
    arn String
    ARN of the Stream Key.
    channelArn String
    id String
    The provider-assigned unique ID for this managed resource.
    tags Map<String>
    Map of tags assigned to the resource.
    value String
    Stream Key value.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws-v6 logo
    AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate