Class CfnPlaybackKeyPair
The AWS::IVS::PlaybackKeyPair
resource specifies an playback key pair.
Inherited Members
Namespace: Amazon.CDK.AWS.Ivs
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPlaybackKeyPair : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnPlaybackKeyPair
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-playbackkeypair.html
CloudformationResource: AWS::IVS::PlaybackKeyPair
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Ivs;
var cfnPlaybackKeyPair = new CfnPlaybackKeyPair(this, "MyCfnPlaybackKeyPair", new CfnPlaybackKeyPairProps {
Name = "name",
PublicKeyMaterial = "publicKeyMaterial",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnPlaybackKeyPair(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPlaybackKeyPair(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnPlaybackKeyPair(Construct, String, ICfnPlaybackKeyPairProps) |
Properties
AttrArn | Key-pair ARN. |
AttrFingerprint | Key-pair identifier. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | Playback-key-pair name. |
PublicKeyMaterial | The public portion of a customer-generated key pair. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPlaybackKeyPair(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPlaybackKeyPair(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPlaybackKeyPair(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPlaybackKeyPair(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnPlaybackKeyPair(Construct, String, ICfnPlaybackKeyPairProps)
public CfnPlaybackKeyPair(Construct scope, string id, ICfnPlaybackKeyPairProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnPlaybackKeyPairProps
Resource properties.
Properties
AttrArn
Key-pair ARN.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:ivs:us-west-2:693991300569:playback-key/f99cde61-c2b0-4df3-8941-ca7d38acca1a
CloudformationAttribute: Arn
AttrFingerprint
Key-pair identifier.
public virtual string AttrFingerprint { get; }
Property Value
System.String
Remarks
For example: 98:0d:1a:a0:19:96:1e:ea:0a:0a:2c:9a:42:19:2b:e7
CloudformationAttribute: Fingerprint
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Name
Playback-key-pair name.
public virtual string Name { get; set; }
Property Value
System.String
PublicKeyMaterial
The public portion of a customer-generated key pair.
public virtual string PublicKeyMaterial { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>