software.amazon.awscdk.services.ivs

Class CfnPlaybackKeyPair

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ivs.CfnPlaybackKeyPair

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.134Z")
public class CfnPlaybackKeyPair
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IVS::PlaybackKeyPair`.

The AWS::IVS::PlaybackKeyPair resource specifies an playback key pair. uses a public playback key to validate playback tokens that have been signed with the corresponding private key. For more information, see Setting Up Private Channels in the Amazon Interactive Video Service User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 CfnPlaybackKeyPair cfnPlaybackKeyPair = CfnPlaybackKeyPair.Builder.create(this, "MyCfnPlaybackKeyPair")
         .name("name")
         .publicKeyMaterial("publicKeyMaterial")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPlaybackKeyPair.Builder A fluent builder for CfnPlaybackKeyPair.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPlaybackKeyPair(Construct scope, java.lang.String id) Create a new `AWS::IVS::PlaybackKeyPair`.
	CfnPlaybackKeyPair(Construct scope, java.lang.String id, CfnPlaybackKeyPairProps props) Create a new `AWS::IVS::PlaybackKeyPair`.
protected	CfnPlaybackKeyPair(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPlaybackKeyPair(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() Key-pair ARN.
java.lang.String	getAttrFingerprint() Key-pair identifier.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() Playback-key-pair name.
java.lang.String	getPublicKeyMaterial() The public portion of a customer-generated key pair.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setName(java.lang.String value) Playback-key-pair name.
void	setPublicKeyMaterial(java.lang.String value) The public portion of a customer-generated key pair.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPlaybackKeyPair

protected CfnPlaybackKeyPair(software.amazon.jsii.JsiiObjectRef objRef)

CfnPlaybackKeyPair

protected CfnPlaybackKeyPair(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPlaybackKeyPair

public CfnPlaybackKeyPair(Construct scope,
                          java.lang.String id,
                          CfnPlaybackKeyPairProps props)

Create a new `AWS::IVS::PlaybackKeyPair`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnPlaybackKeyPair

public CfnPlaybackKeyPair(Construct scope,
                          java.lang.String id)

Create a new `AWS::IVS::PlaybackKeyPair`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

Key-pair ARN.

For example: arn:aws:ivs:us-west-2:693991300569:playback-key/f99cde61-c2b0-4df3-8941-ca7d38acca1a

getAttrFingerprint

public java.lang.String getAttrFingerprint()

Key-pair identifier.

For example: 98:0d:1a:a0:19:96:1e:ea:0a:0a:2c:9a:42:19:2b:e7

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getName

public java.lang.String getName()

Playback-key-pair name.

The value does not need to be unique.

setName

public void setName(java.lang.String value)

Playback-key-pair name.

The value does not need to be unique.

getPublicKeyMaterial

public java.lang.String getPublicKeyMaterial()

The public portion of a customer-generated key pair.

setPublicKeyMaterial

public void setPublicKeyMaterial(java.lang.String value)

The public portion of a customer-generated key pair.