CfnRecordingConfiguration

class aws_cdk.aws_ivs.CfnRecordingConfiguration(scope, id, *, destination_configuration, name=None, recording_reconnect_window_seconds=None, rendition_configuration=None, tags=None, thumbnail_configuration=None)

Bases: CfnResource

The AWS::IVS::RecordingConfiguration resource specifies an recording configuration.

A recording configuration enables the recording of a channel’s live streams to a data store. Multiple channels can reference the same recording configuration. For more information, see RecordingConfiguration in the Amazon IVS Low-Latency Streaming API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html
CloudformationResource:: AWS::IVS::RecordingConfiguration
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ivs as ivs

cfn_recording_configuration = ivs.CfnRecordingConfiguration(self, "MyCfnRecordingConfiguration",
    destination_configuration=ivs.CfnRecordingConfiguration.DestinationConfigurationProperty(
        s3=ivs.CfnRecordingConfiguration.S3DestinationConfigurationProperty(
            bucket_name="bucketName"
        )
    ),

    # the properties below are optional
    name="name",
    recording_reconnect_window_seconds=123,
    rendition_configuration=ivs.CfnRecordingConfiguration.RenditionConfigurationProperty(
        renditions=["renditions"],
        rendition_selection="renditionSelection"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thumbnail_configuration=ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty(
        recording_mode="recordingMode",
        resolution="resolution",
        storage=["storage"],
        target_interval_seconds=123
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
destination_configuration (Union[IResolvable, DestinationConfigurationProperty, Dict[str, Any]]) – A destination configuration describes an S3 bucket where recorded video will be stored. See the DestinationConfiguration property type for more information.
name (Optional[str]) – Recording-configuration name. The value does not need to be unique.
recording_reconnect_window_seconds (Union[int, float, None]) – If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default : 0 Default: - 0
rendition_configuration (Union[IResolvable, RenditionConfigurationProperty, Dict[str, Any], None]) – A rendition configuration describes which renditions should be recorded for a stream. See the RenditionConfiguration property type for more information.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
thumbnail_configuration (Union[IResolvable, ThumbnailConfigurationProperty, Dict[str, Any], None]) – A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session. See the ThumbnailConfiguration property type for more information.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IVS::RecordingConfiguration'

attr_arn

The recording configuration ARN.

For example: arn:aws:ivs:us-west-2:123456789012:recording-configuration/abcdABCDefgh

CloudformationAttribute:: Arn

attr_state

Indicates the current state of the recording configuration.

When the state is ACTIVE , the configuration is ready to record a channel stream. Valid values: CREATING | CREATE_FAILED | ACTIVE .

CloudformationAttribute:: State

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

destination_configuration: A destination configuration describes an S3 bucket where recorded video will be stored.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: Recording-configuration name.

node: The tree node.

recording_reconnect_window_seconds: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rendition_configuration: A rendition configuration describes which renditions should be recorded for a stream.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: An array of key-value pairs to apply to this resource.

thumbnail_configuration: A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

DestinationConfigurationProperty

class CfnRecordingConfiguration.DestinationConfigurationProperty(*, s3=None)

Bases: object

The DestinationConfiguration property type describes the location where recorded videos will be stored.

Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.

Parameters:: s3 (Union[IResolvable, S3DestinationConfigurationProperty, Dict[str, Any], None]) – An S3 destination configuration where recorded videos will be stored. See the S3DestinationConfiguration property type for more information.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-destinationconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ivs as ivs

destination_configuration_property = ivs.CfnRecordingConfiguration.DestinationConfigurationProperty(
    s3=ivs.CfnRecordingConfiguration.S3DestinationConfigurationProperty(
        bucket_name="bucketName"
    )
)

Attributes

s3

An S3 destination configuration where recorded videos will be stored.

See the S3DestinationConfiguration property type for more information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-destinationconfiguration.html#cfn-ivs-recordingconfiguration-destinationconfiguration-s3

RenditionConfigurationProperty

class CfnRecordingConfiguration.RenditionConfigurationProperty(*, renditions=None, rendition_selection=None)

Bases: object

The RenditionConfiguration property type describes which renditions should be recorded for a stream.

Parameters:

renditions (Optional[Sequence[str]]) – A list of which renditions are recorded for a stream, if renditionSelection is CUSTOM ; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3 .
rendition_selection (Optional[str]) – The set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions can be specified in the renditions field. Default: ALL . Default: - “ALL”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ivs as ivs

rendition_configuration_property = ivs.CfnRecordingConfiguration.RenditionConfigurationProperty(
    renditions=["renditions"],
    rendition_selection="renditionSelection"
)

Attributes

rendition_selection

The set of renditions are recorded for a stream.

For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions can be specified in the renditions field. Default: ALL .

Default:

“ALL”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html#cfn-ivs-recordingconfiguration-renditionconfiguration-renditionselection

renditions

A list of which renditions are recorded for a stream, if renditionSelection is CUSTOM ;

otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html#cfn-ivs-recordingconfiguration-renditionconfiguration-renditions

S3DestinationConfigurationProperty

class CfnRecordingConfiguration.S3DestinationConfigurationProperty(*, bucket_name)

Bases: object

The S3DestinationConfiguration property type describes an S3 location where recorded videos will be stored.

Parameters:: bucket_name (str) – Location (S3 bucket name) where recorded videos will be stored.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-s3destinationconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ivs as ivs

s3_destination_configuration_property = ivs.CfnRecordingConfiguration.S3DestinationConfigurationProperty(
    bucket_name="bucketName"
)

Attributes

bucket_name

Location (S3 bucket name) where recorded videos will be stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-s3destinationconfiguration.html#cfn-ivs-recordingconfiguration-s3destinationconfiguration-bucketname

ThumbnailConfigurationProperty

class CfnRecordingConfiguration.ThumbnailConfigurationProperty(*, recording_mode=None, resolution=None, storage=None, target_interval_seconds=None)

Bases: object

The ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.

Parameters:

recording_mode (Optional[str]) – Thumbnail recording mode. Valid values:. - DISABLED : Use DISABLED to disable the generation of thumbnails for recorded video. - INTERVAL : Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the TargetIntervalSeconds property. Default : INTERVAL Default: - “INTERVAL”
resolution (Optional[str]) –
The desired resolution of recorded thumbnails for a stream. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3 .
storage (Optional[Sequence[str]]) – The format in which thumbnails are recorded for a stream. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/thumbnails/latest/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds . You can enable both SEQUENTIAL and LATEST . Default: SEQUENTIAL .
target_interval_seconds (Union[int, float, None]) – The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL . .. epigraph:: Setting a value for TargetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the TargetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the TargetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings. Default : 60 Valid Range : Minumum value of 1. Maximum value of 60. Default: - 60

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ivs as ivs

thumbnail_configuration_property = ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty(
    recording_mode="recordingMode",
    resolution="resolution",
    storage=["storage"],
    target_interval_seconds=123
)

Attributes

recording_mode

.

DISABLED : Use DISABLED to disable the generation of thumbnails for recorded video.
INTERVAL : Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the TargetIntervalSeconds property.

Default : INTERVAL

Default:

“INTERVAL”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-recordingmode

Type:

Thumbnail recording mode. Valid values

resolution

The desired resolution of recorded thumbnails for a stream.

Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-resolution

storage

The format in which thumbnails are recorded for a stream.

SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/thumbnails/latest/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds . You can enable both SEQUENTIAL and LATEST . Default: SEQUENTIAL .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-storage

target_interval_seconds

//docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-recordingmode>`_ is INTERVAL .

Setting a value for TargetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the TargetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the TargetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Default : 60

Valid Range : Minumum value of 1. Maximum value of 60.

Default:

60

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-targetintervalseconds

Type:

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if `RecordingMode <https