software.amazon.awscdk.services.ivs

Class CfnStreamKey

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.CfnStreamKey

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

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

A CloudFormation `AWS::IVS::StreamKey`.

The AWS::IVS::StreamKey resource specifies an stream key associated with the referenced channel. Use a stream key to initiate a live stream.

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.*;
 CfnStreamKey cfnStreamKey = CfnStreamKey.Builder.create(this, "MyCfnStreamKey")
         .channelArn("channelArn")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnStreamKey(Construct scope, java.lang.String id, CfnStreamKeyProps props) Create a new `AWS::IVS::StreamKey`.
protected	CfnStreamKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStreamKey(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The stream-key ARN.
java.lang.String	getAttrValue() The stream-key value.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getChannelArn() Channel ARN for the stream.
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	setChannelArn(java.lang.String value) Channel ARN for the stream.

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

CfnStreamKey

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

CfnStreamKey

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

CfnStreamKey

public CfnStreamKey(Construct scope,
                    java.lang.String id,
                    CfnStreamKeyProps props)

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

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. 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()

The stream-key ARN.

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

getAttrValue

public java.lang.String getAttrValue()

The stream-key value.

For example: sk_us-west-2_abcdABCDefgh_567890abcdef

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 .

getChannelArn

public java.lang.String getChannelArn()

Channel ARN for the stream.

setChannelArn

public void setChannelArn(java.lang.String value)

Channel ARN for the stream.