aws.ivs.PlaybackKeyPair
Explore with Pulumi AI
Resource for managing an AWS IVS (Interactive Video) Playback Key Pair.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const example = new aws.ivs.PlaybackKeyPair("example", {publicKey: std.file({
input: "./public-key.pem",
}).then(invoke => invoke.result)});
import pulumi
import pulumi_aws as aws
import pulumi_std as std
example = aws.ivs.PlaybackKeyPair("example", public_key=std.file(input="./public-key.pem").result)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ivs"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeFile, err := std.File(ctx, &std.FileArgs{
Input: "./public-key.pem",
}, nil)
if err != nil {
return err
}
_, err = ivs.NewPlaybackKeyPair(ctx, "example", &ivs.PlaybackKeyPairArgs{
PublicKey: pulumi.String(invokeFile.Result),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ivs.PlaybackKeyPair("example", new()
{
PublicKey = Std.File.Invoke(new()
{
Input = "./public-key.pem",
}).Apply(invoke => invoke.Result),
});
});
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(StdFunctions.file(FileArgs.builder()
.input("./public-key.pem")
.build()).result())
.build());
}
}
resources:
example:
type: aws:ivs:PlaybackKeyPair
properties:
publicKey:
fn::invoke:
Function: std:file
Arguments:
input: ./public-key.pem
Return: result
Create PlaybackKeyPair Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PlaybackKeyPair(name: string, args: PlaybackKeyPairArgs, opts?: CustomResourceOptions);
@overload
def PlaybackKeyPair(resource_name: str,
args: PlaybackKeyPairArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PlaybackKeyPair(resource_name: str,
opts: Optional[ResourceOptions] = None,
public_key: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var playbackKeyPairResource = new Aws.Ivs.PlaybackKeyPair("playbackKeyPairResource", new()
{
PublicKey = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := ivs.NewPlaybackKeyPair(ctx, "playbackKeyPairResource", &ivs.PlaybackKeyPairArgs{
PublicKey: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var playbackKeyPairResource = new PlaybackKeyPair("playbackKeyPairResource", PlaybackKeyPairArgs.builder()
.publicKey("string")
.name("string")
.tags(Map.of("string", "string"))
.build());
playback_key_pair_resource = aws.ivs.PlaybackKeyPair("playbackKeyPairResource",
public_key="string",
name="string",
tags={
"string": "string",
})
const playbackKeyPairResource = new aws.ivs.PlaybackKeyPair("playbackKeyPairResource", {
publicKey: "string",
name: "string",
tags: {
string: "string",
},
});
type: aws:ivs:PlaybackKeyPair
properties:
name: string
publicKey: string
tags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PlaybackKeyPair resource accepts the following input properties:
- Public
Key string Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- Name string
- Playback Key Pair name.
- 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.
- Public
Key string Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- Name string
- Playback Key Pair name.
- 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.
- public
Key String Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- name String
- Playback Key Pair name.
- 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.
- public
Key string Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- name string
- Playback Key Pair name.
- {[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.
The following arguments are optional:
- name str
- Playback Key Pair name.
- 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.
- public
Key String Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- name String
- Playback Key Pair name.
- 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.
- 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.
- 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.
- 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.
- {[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.
- 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.
- 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.
- Arn string
- ARN of the Playback Key Pair.
- Fingerprint string
- Key-pair identifier.
- Name string
- Playback Key Pair name.
- Public
Key string Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- 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. - 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.
- Public
Key string Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- 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. - 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.
- public
Key String Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- 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. - 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.
- public
Key string Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- {[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. - {[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.
The following arguments are optional:
- 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. - 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.
- public
Key String Public portion of a customer-generated key pair. Must be an ECDSA public key in PEM format.
The following arguments are optional:
- 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. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Import
Using pulumi import
, import IVS (Interactive Video) Playback Key Pair using the ARN. For example:
$ pulumi import aws:ivs/playbackKeyPair:PlaybackKeyPair example arn:aws:ivs:us-west-2:326937407773:playback-key/KDJRJNQhiQzA
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.