Class CfnStreamKey

The AWS::IVS::StreamKey resource specifies an stream key associated with the referenced channel.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnStreamKey
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Ivs
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStreamKey : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStreamKey
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

Use a stream key to initiate a live stream.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-streamkey.html

CloudformationResource: AWS::IVS::StreamKey

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 cfnStreamKey = new CfnStreamKey(this, "MyCfnStreamKey", new CfnStreamKeyProps {
    ChannelArn = "channelArn",

    // the properties below are optional
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnStreamKey(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnStreamKey(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnStreamKey(Construct, String, ICfnStreamKeyProps)

Properties

AttrArn

The stream-key ARN.
AttrValue

The stream-key value.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
ChannelArn

Channel ARN for the stream.
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

CfnStreamKey(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnStreamKey(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnStreamKey(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnStreamKey(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnStreamKey(Construct, String, ICfnStreamKeyProps)

public CfnStreamKey(Construct scope, string id, ICfnStreamKeyProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnStreamKeyProps

Resource properties.

Properties

AttrArn

The stream-key ARN.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

For example: arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6

CloudformationAttribute: Arn

AttrValue

The stream-key value.

public virtual string AttrValue { get; }
Property Value

System.String

Remarks

For example: sk_us-west-2_abcdABCDefgh_567890abcdef

CloudformationAttribute: Value

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

ChannelArn

Channel ARN for the stream.

public virtual string ChannelArn { get; set; }
Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

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>

Overrides

Implements