`stream` Submodule

Constructs

Stream

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream cloudflare_stream}.

Initializers

import { stream } from '@cdktf/provider-cloudflare'

new stream.Stream(scope: Construct, id: string, config: StreamConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`StreamConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: StreamConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`resetAllowedOrigins`	No description.
`resetCreator`	No description.
`resetIdentifier`	No description.
`resetMaxDurationSeconds`	No description.
`resetMeta`	No description.
`resetRequireSignedUrls`	No description.
`resetScheduledDeletion`	No description.
`resetThumbnailTimestampPct`	No description.
`resetUploadExpiry`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`resetAllowedOrigins`

public resetAllowedOrigins(): void

`resetCreator`

public resetCreator(): void

`resetIdentifier`

public resetIdentifier(): void

`resetMaxDurationSeconds`

public resetMaxDurationSeconds(): void

`resetMeta`

public resetMeta(): void

`resetRequireSignedUrls`

public resetRequireSignedUrls(): void

`resetScheduledDeletion`

public resetScheduledDeletion(): void

`resetThumbnailTimestampPct`

public resetThumbnailTimestampPct(): void

`resetUploadExpiry`

public resetUploadExpiry(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a Stream resource upon running "cdktf plan ".

`isConstruct`

import { stream } from '@cdktf/provider-cloudflare'

stream.Stream.isConstruct(x: any)

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.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { stream } from '@cdktf/provider-cloudflare'

stream.Stream.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { stream } from '@cdktf/provider-cloudflare'

stream.Stream.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { stream } from '@cdktf/provider-cloudflare'

stream.Stream.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a Stream resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

The construct id used in the generated config for the Stream to import.

`importFromId`^Required

Type: string

The id of the existing Stream that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the Stream to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`created`	`string`	No description.
`duration`	`number`	No description.
`input`	`StreamInputOutputReference`	No description.
`liveInput`	`string`	No description.
`modified`	`string`	No description.
`playback`	`StreamPlaybackOutputReference`	No description.
`preview`	`string`	No description.
`readyToStream`	`cdktf.IResolvable`	No description.
`readyToStreamAt`	`string`	No description.
`size`	`number`	No description.
`status`	`StreamStatusOutputReference`	No description.
`thumbnail`	`string`	No description.
`uid`	`string`	No description.
`uploaded`	`string`	No description.
`watermark`	`StreamWatermarkOutputReference`	No description.
`accountIdInput`	`string`	No description.
`allowedOriginsInput`	`string[]`	No description.
`creatorInput`	`string`	No description.
`identifierInput`	`string`	No description.
`maxDurationSecondsInput`	`number`	No description.
`metaInput`	`string`	No description.
`requireSignedUrlsInput`	`boolean \| cdktf.IResolvable`	No description.
`scheduledDeletionInput`	`string`	No description.
`thumbnailTimestampPctInput`	`number`	No description.
`uploadExpiryInput`	`string`	No description.
`accountId`	`string`	No description.
`allowedOrigins`	`string[]`	No description.
`creator`	`string`	No description.
`identifier`	`string`	No description.
`maxDurationSeconds`	`number`	No description.
`meta`	`string`	No description.
`requireSignedUrls`	`boolean \| cdktf.IResolvable`	No description.
`scheduledDeletion`	`string`	No description.
`thumbnailTimestampPct`	`number`	No description.
`uploadExpiry`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`created`^Required

public readonly created: string;

Type: string

`duration`^Required

public readonly duration: number;

Type: number

`input`^Required

public readonly input: StreamInputOutputReference;

Type: StreamInputOutputReference

`liveInput`^Required

public readonly liveInput: string;

Type: string

`modified`^Required

public readonly modified: string;

Type: string

`playback`^Required

public readonly playback: StreamPlaybackOutputReference;

Type: StreamPlaybackOutputReference

`preview`^Required

public readonly preview: string;

Type: string

`readyToStream`^Required

public readonly readyToStream: IResolvable;

Type: cdktf.IResolvable

`readyToStreamAt`^Required

public readonly readyToStreamAt: string;

Type: string

`size`^Required

public readonly size: number;

Type: number

`status`^Required

public readonly status: StreamStatusOutputReference;

Type: StreamStatusOutputReference

`thumbnail`^Required

public readonly thumbnail: string;

Type: string

`uid`^Required

public readonly uid: string;

Type: string

`uploaded`^Required

public readonly uploaded: string;

Type: string

`watermark`^Required

public readonly watermark: StreamWatermarkOutputReference;

Type: StreamWatermarkOutputReference

`accountIdInput`^Optional

public readonly accountIdInput: string;

Type: string

`allowedOriginsInput`^Optional

public readonly allowedOriginsInput: string[];

Type: string[]

`creatorInput`^Optional

public readonly creatorInput: string;

Type: string

`identifierInput`^Optional

public readonly identifierInput: string;

Type: string

`maxDurationSecondsInput`^Optional

public readonly maxDurationSecondsInput: number;

Type: number

`metaInput`^Optional

public readonly metaInput: string;

Type: string

`requireSignedUrlsInput`^Optional

public readonly requireSignedUrlsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`scheduledDeletionInput`^Optional

public readonly scheduledDeletionInput: string;

Type: string

`thumbnailTimestampPctInput`^Optional

public readonly thumbnailTimestampPctInput: number;

Type: number

`uploadExpiryInput`^Optional

public readonly uploadExpiryInput: string;

Type: string

`accountId`^Required

public readonly accountId: string;

Type: string

`allowedOrigins`^Required

public readonly allowedOrigins: string[];

Type: string[]

`creator`^Required

public readonly creator: string;

Type: string

`identifier`^Required

public readonly identifier: string;

Type: string

`maxDurationSeconds`^Required

public readonly maxDurationSeconds: number;

Type: number

`meta`^Required

public readonly meta: string;

Type: string

`requireSignedUrls`^Required

public readonly requireSignedUrls: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`scheduledDeletion`^Required

public readonly scheduledDeletion: string;

Type: string

`thumbnailTimestampPct`^Required

public readonly thumbnailTimestampPct: number;

Type: number

`uploadExpiry`^Required

public readonly uploadExpiry: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

StreamConfig

Initializer

import { stream } from '@cdktf/provider-cloudflare'

const streamConfig: stream.StreamConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`accountId`	`string`	The account identifier tag.
`allowedOrigins`	`string[]`	Lists the origins allowed to display the video.
`creator`	`string`	A user-defined identifier for the media creator.
`identifier`	`string`	A Cloudflare-generated unique identifier for a media item.
`maxDurationSeconds`	`number`	The maximum duration in seconds for a video upload.
`meta`	`string`	A user modifiable key-value store used to reference other systems of record for managing videos.
`requireSignedUrls`	`boolean \| cdktf.IResolvable`	Indicates whether the video can be a accessed using the UID.
`scheduledDeletion`	`string`	Indicates the date and time at which the video will be deleted.
`thumbnailTimestampPct`	`number`	The timestamp for a thumbnail image calculated as a percentage value of the video's duration.
`uploadExpiry`	`string`	The date and time when the video upload URL is no longer valid for direct user uploads.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`accountId`^Required

public readonly accountId: string;

Type: string

The account identifier tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#account_id Stream#account_id}

`allowedOrigins`^Optional

public readonly allowedOrigins: string[];

Type: string[]

Lists the origins allowed to display the video.

Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#allowed_origins Stream#allowed_origins}

`creator`^Optional

public readonly creator: string;

Type: string

A user-defined identifier for the media creator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#creator Stream#creator}

`identifier`^Optional

public readonly identifier: string;

Type: string

A Cloudflare-generated unique identifier for a media item.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#identifier Stream#identifier}

`maxDurationSeconds`^Optional

public readonly maxDurationSeconds: number;

Type: number

The maximum duration in seconds for a video upload.

Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#max_duration_seconds Stream#max_duration_seconds}

`meta`^Optional

public readonly meta: string;

Type: string

A user modifiable key-value store used to reference other systems of record for managing videos.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#meta Stream#meta}

`requireSignedUrls`^Optional

public readonly requireSignedUrls: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Indicates whether the video can be a accessed using the UID.

When set to true, a signed token must be generated with a signing key to view the video.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#require_signed_urls Stream#require_signed_urls}

`scheduledDeletion`^Optional

public readonly scheduledDeletion: string;

Type: string

Indicates the date and time at which the video will be deleted.

Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#scheduled_deletion Stream#scheduled_deletion}

`thumbnailTimestampPct`^Optional

public readonly thumbnailTimestampPct: number;

Type: number

The timestamp for a thumbnail image calculated as a percentage value of the video's duration.

To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#thumbnail_timestamp_pct Stream#thumbnail_timestamp_pct}

`uploadExpiry`^Optional

public readonly uploadExpiry: string;

Type: string

The date and time when the video upload URL is no longer valid for direct user uploads.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/stream#upload_expiry Stream#upload_expiry}

StreamInput

Initializer

import { stream } from '@cdktf/provider-cloudflare'

const streamInput: stream.StreamInput = { ... }

StreamPlayback

Initializer

import { stream } from '@cdktf/provider-cloudflare'

const streamPlayback: stream.StreamPlayback = { ... }

StreamStatus

Initializer

import { stream } from '@cdktf/provider-cloudflare'

const streamStatus: stream.StreamStatus = { ... }

StreamWatermark

Initializer

import { stream } from '@cdktf/provider-cloudflare'

const streamWatermark: stream.StreamWatermark = { ... }

Classes

StreamInputOutputReference

Initializers

import { stream } from '@cdktf/provider-cloudflare'

new stream.StreamInputOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`height`	`number`	No description.
`width`	`number`	No description.
`internalValue`	`StreamInput`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`height`^Required

public readonly height: number;

Type: number

`width`^Required

public readonly width: number;

Type: number

`internalValue`^Optional

public readonly internalValue: StreamInput;

Type: StreamInput

StreamPlaybackOutputReference

Initializers

import { stream } from '@cdktf/provider-cloudflare'

new stream.StreamPlaybackOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`dash`	`string`	No description.
`hls`	`string`	No description.
`internalValue`	`StreamPlayback`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`dash`^Required

public readonly dash: string;

Type: string

`hls`^Required

public readonly hls: string;

Type: string

`internalValue`^Optional

public readonly internalValue: StreamPlayback;

Type: StreamPlayback

StreamStatusOutputReference

Initializers

import { stream } from '@cdktf/provider-cloudflare'

new stream.StreamStatusOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`errorReasonCode`	`string`	No description.
`errorReasonText`	`string`	No description.
`pctComplete`	`string`	No description.
`state`	`string`	No description.
`internalValue`	`StreamStatus`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`errorReasonCode`^Required

public readonly errorReasonCode: string;

Type: string

`errorReasonText`^Required

public readonly errorReasonText: string;

Type: string

`pctComplete`^Required

public readonly pctComplete: string;

Type: string

`state`^Required

public readonly state: string;

Type: string

`internalValue`^Optional

public readonly internalValue: StreamStatus;

Type: StreamStatus

StreamWatermarkOutputReference

Initializers

import { stream } from '@cdktf/provider-cloudflare'

new stream.StreamWatermarkOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`created`	`string`	No description.
`downloadedFrom`	`string`	No description.
`height`	`number`	No description.
`name`	`string`	No description.
`opacity`	`number`	No description.
`padding`	`number`	No description.
`position`	`string`	No description.
`scale`	`number`	No description.
`size`	`number`	No description.
`uid`	`string`	No description.
`width`	`number`	No description.
`internalValue`	`StreamWatermark`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`created`^Required

public readonly created: string;

Type: string

`downloadedFrom`^Required

public readonly downloadedFrom: string;

Type: string

`height`^Required

public readonly height: number;

Type: number

`name`^Required

public readonly name: string;

Type: string

`opacity`^Required

public readonly opacity: number;

Type: number

`padding`^Required

public readonly padding: number;

Type: number

`position`^Required

public readonly position: string;

Type: string

`scale`^Required

public readonly scale: number;

Type: number

`size`^Required

public readonly size: number;

Type: number

`uid`^Required

public readonly uid: string;

Type: string

`width`^Required

public readonly width: number;

Type: number

`internalValue`^Optional

public readonly internalValue: StreamWatermark;

Type: StreamWatermark

FilesExpand file tree

stream.typescript.md

Latest commit

History

stream.typescript.md

File metadata and controls

stream Submodule

Constructs

Stream

Initializers

scopeRequired

idRequired

configRequired

Methods

toString

addOverride

pathRequired

valueRequired

overrideLogicalId

newLogicalIdRequired

resetOverrideLogicalId

toHclTerraform

toMetadata

toTerraform

addMoveTarget

moveTargetRequired

getAnyMapAttribute

terraformAttributeRequired

getBooleanAttribute

terraformAttributeRequired

getBooleanMapAttribute

terraformAttributeRequired

getListAttribute

terraformAttributeRequired

getNumberAttribute

terraformAttributeRequired

getNumberListAttribute

terraformAttributeRequired

getNumberMapAttribute

terraformAttributeRequired

getStringAttribute

terraformAttributeRequired

getStringMapAttribute

terraformAttributeRequired

hasResourceMove

importFrom

idRequired

providerOptional

interpolationForAttribute

terraformAttributeRequired

moveFromId

idRequired

moveTo

moveTargetRequired

indexOptional

moveToId

idRequired

resetAllowedOrigins

resetCreator

resetIdentifier

resetMaxDurationSeconds

resetMeta

resetRequireSignedUrls

resetScheduledDeletion

resetThumbnailTimestampPct

resetUploadExpiry

Static Functions

isConstruct

xRequired

isTerraformElement

xRequired

isTerraformResource

xRequired

generateConfigForImport

scopeRequired

importToIdRequired

importFromIdRequired

providerOptional

Properties

nodeRequired

`stream` Submodule

`scope`^Required

`id`^Required

`config`^Required

`toString`

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`addMoveTarget`

`moveTarget`^Required

`getAnyMapAttribute`

`terraformAttribute`^Required

`getBooleanAttribute`

`terraformAttribute`^Required

`getBooleanMapAttribute`

`terraformAttribute`^Required

`getListAttribute`

`terraformAttribute`^Required

`getNumberAttribute`

`terraformAttribute`^Required

`getNumberListAttribute`

`terraformAttribute`^Required

`getNumberMapAttribute`

`terraformAttribute`^Required

`getStringAttribute`

`terraformAttribute`^Required

`getStringMapAttribute`

`terraformAttribute`^Required

`hasResourceMove`

`importFrom`

`id`^Required

`provider`^Optional

`interpolationForAttribute`

`terraformAttribute`^Required

`moveFromId`

`id`^Required

`moveTo`

`moveTarget`^Required

`index`^Optional

`moveToId`

`id`^Required

`resetAllowedOrigins`

`resetCreator`

`resetIdentifier`

`resetMaxDurationSeconds`

`resetMeta`

`resetRequireSignedUrls`

`resetScheduledDeletion`

`resetThumbnailTimestampPct`

`resetUploadExpiry`

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isTerraformResource`

`x`^Required

`generateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required

`terraformMetaArguments`^Required

`terraformResourceType`^Required

`terraformGeneratorMetadata`^Optional

`connection`^Optional

`count`^Optional

`dependsOn`^Optional

`forEach`^Optional

`lifecycle`^Optional

`provider`^Optional