Package software.amazon.awscdk.services.ivs

Class CfnPlaybackKeyPair

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ivs.CfnPlaybackKeyPair
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPlaybackKeyPairRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:22.930Z") @Stability(Stable) public class CfnPlaybackKeyPair extends CfnResource implements IInspectable, IPlaybackKeyPairRef, ITaggable
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 IVS Low-Latency Streaming 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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPlaybackKeyPair

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

    • CfnPlaybackKeyPair

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

    • CfnPlaybackKeyPair

      @Stability(Stable) public CfnPlaybackKeyPair(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnPlaybackKeyPairProps props)
      Create a new AWS::IVS::PlaybackKeyPair.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnPlaybackKeyPair

      @Stability(Stable) public CfnPlaybackKeyPair(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::IVS::PlaybackKeyPair.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForPlaybackKeyPair

      @Stability(Stable) @NotNull public static String arnForPlaybackKeyPair(@NotNull IPlaybackKeyPairRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnPlaybackKeyPair

      @Stability(Stable) @NotNull public static Boolean isCfnPlaybackKeyPair(@NotNull Object x)
      Checks whether the given object is a CfnPlaybackKeyPair.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Key-pair ARN.

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

    • getAttrFingerprint

      @Stability(Stable) @NotNull public String getAttrFingerprint()
      Key-pair identifier.

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPlaybackKeyPairRef

      @Stability(Stable) @NotNull public PlaybackKeyPairReference getPlaybackKeyPairRef()
      A reference to a PlaybackKeyPair resource.
      Specified by:
      getPlaybackKeyPairRef in interface IPlaybackKeyPairRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @Nullable public String getName()
      Playback-key-pair name.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Playback-key-pair name.

    • getPublicKeyMaterial

      @Stability(Stable) @Nullable public String getPublicKeyMaterial()
      The public portion of a customer-generated key pair.

    • setPublicKeyMaterial

      @Stability(Stable) public void setPublicKeyMaterial(@Nullable String value)
      The public portion of a customer-generated key pair.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.