@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:37.140Z") public class CfnStreamKey extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnStreamKey.Builder
A fluent builder for
CfnStreamKey . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnStreamKey(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnStreamKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnStreamKey(Construct scope, java.lang.String id, CfnStreamKeyProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
For example: arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6
public java.lang.String getAttrValue()
For example: sk_us-west-2_abcdABCDefgh_567890abcdef
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getChannelArn()
public void setChannelArn(java.lang.String value)