Docs Packages
  1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. ivs
  5. PlaybackKeyPair
aws logo
AWS Classic v5.41.0, May 15 23

aws.ivs.PlaybackKeyPair

Explore with Pulumi AI

Resource for managing an AWS IVS (Interactive Video) Playback Key Pair.

Example Usage

Basic Usage

using System.Collections.Generic;
using System.IO;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ivs.PlaybackKeyPair("example", new()
    {
        PublicKey = File.ReadAllText("./public-key.pem"),
    });

});

package main

import (
	"os"

	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ivs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := os.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ivs.NewPlaybackKeyPair(ctx, "example", &ivs.PlaybackKeyPairArgs{
			PublicKey: readFileOrPanic("./public-key.pem"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ivs.PlaybackKeyPair;
import com.pulumi.aws.ivs.PlaybackKeyPairArgs;
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) {
        var example = new PlaybackKeyPair("example", PlaybackKeyPairArgs.builder()        
            .publicKey(Files.readString(Paths.get("./public-key.pem")))
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.ivs.PlaybackKeyPair("example", public_key=(lambda path: open(path).read())("./public-key.pem"))

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

const example = new aws.ivs.PlaybackKeyPair("example", {publicKey: fs.readFileSync("./public-key.pem")});

resources:
  example:
    type: aws:ivs:PlaybackKeyPair
    properties:
      # public-key.pem is a file that contains an ECDSA public key in PEM format.
      publicKey:
        fn::readFile: ./public-key.pem

Create PlaybackKeyPair Resource

new PlaybackKeyPair(name: string, args: PlaybackKeyPairArgs, opts?: CustomResourceOptions);
@overload
def PlaybackKeyPair(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    name: Optional[str] = None,
                    public_key: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
@overload
def PlaybackKeyPair(resource_name: str,
                    args: PlaybackKeyPairArgs,
                    opts: Optional[ResourceOptions] = None)
func NewPlaybackKeyPair(ctx *Context, name string, args PlaybackKeyPairArgs, opts ...ResourceOption) (*PlaybackKeyPair, error)
public PlaybackKeyPair(string name, PlaybackKeyPairArgs args, CustomResourceOptions? opts = null)
public PlaybackKeyPair(String name, PlaybackKeyPairArgs args)
public PlaybackKeyPair(String name, PlaybackKeyPairArgs args, CustomResourceOptions options)

type: aws:ivs:PlaybackKeyPair
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PlaybackKeyPairArgs
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 PlaybackKeyPairArgs
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 PlaybackKeyPairArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PlaybackKeyPairArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args PlaybackKeyPairArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

PlaybackKeyPair 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 PlaybackKeyPair resource accepts the following input properties:

PublicKey string

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

Name string

Playback Key Pair name.

Tags Dictionary<string, string>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

PublicKey string

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

Name string

Playback Key Pair name.

Tags map[string]string

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

publicKey String

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

name String

Playback Key Pair name.

tags Map<String,String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

publicKey string

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

name string

Playback Key Pair name.

tags {[key: string]: string}

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

public_key str

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

name str

Playback Key Pair name.

tags Mapping[str, str]

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

publicKey String

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

name String

Playback Key Pair name.

tags Map<String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

Arn string

ARN of the Playback Key Pair.

Fingerprint string

Key-pair identifier.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

ARN of the Playback Key Pair.

Fingerprint string

Key-pair identifier.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the Playback Key Pair.

fingerprint String

Key-pair identifier.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

ARN of the Playback Key Pair.

fingerprint string

Key-pair identifier.

id string

The provider-assigned unique ID for this managed resource.

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

ARN of the Playback Key Pair.

fingerprint str

Key-pair identifier.

id str

The provider-assigned unique ID for this managed resource.

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the Playback Key Pair.

fingerprint String

Key-pair identifier.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing PlaybackKeyPair Resource

Get an existing PlaybackKeyPair resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PlaybackKeyPairState, opts?: CustomResourceOptions): PlaybackKeyPair
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        fingerprint: Optional[str] = None,
        name: Optional[str] = None,
        public_key: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> PlaybackKeyPair
func GetPlaybackKeyPair(ctx *Context, name string, id IDInput, state *PlaybackKeyPairState, opts ...ResourceOption) (*PlaybackKeyPair, error)
public static PlaybackKeyPair Get(string name, Input<string> id, PlaybackKeyPairState? state, CustomResourceOptions? opts = null)
public static PlaybackKeyPair get(String name, Output<String> id, PlaybackKeyPairState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string

ARN of the Playback Key Pair.

Fingerprint string

Key-pair identifier.

Name string

Playback Key Pair name.

PublicKey string

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

Tags Dictionary<string, string>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

ARN of the Playback Key Pair.

Fingerprint string

Key-pair identifier.

Name string

Playback Key Pair name.

PublicKey string

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

Tags map[string]string

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the Playback Key Pair.

fingerprint String

Key-pair identifier.

name String

Playback Key Pair name.

publicKey String

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

tags Map<String,String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

ARN of the Playback Key Pair.

fingerprint string

Key-pair identifier.

name string

Playback Key Pair name.

publicKey string

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

tags {[key: string]: string}

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

ARN of the Playback Key Pair.

fingerprint str

Key-pair identifier.

name str

Playback Key Pair name.

public_key str

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

tags Mapping[str, str]

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the Playback Key Pair.

fingerprint String

Key-pair identifier.

name String

Playback Key Pair name.

publicKey String

Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.

tags Map<String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Import

IVS (Interactive Video) Playback Key Pair can be imported using the ARN, e.g.,

 $ pulumi import aws:ivs/playbackKeyPair:PlaybackKeyPair example arn:aws:ivs:us-west-2:326937407773:playback-key/KDJRJNQhiQzA

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.