Skip to content

streamWatermark.csharp.md

Latest commit

 

History

History
1217 lines (759 loc) · 48.2 KB

streamWatermark.csharp.md

File metadata and controls

1217 lines (759 loc) · 48.2 KB
Raw

streamWatermark Submodule

Constructs

StreamWatermarkA

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/stream_watermark cloudflare_stream_watermark}.

Initializers 

using Io.Cdktn.Providers.Cloudflare;

new StreamWatermarkA(Construct Scope, string Id, StreamWatermarkAConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config StreamWatermarkAConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
With Applies one or more mixins to 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".
ResetIdentifier No description.
ResetName No description.
ResetOpacity No description.
ResetPadding No description.
ResetPosition No description.
ResetScale No description.
ResetUrl No description.
ToString 
private string ToString()

Returns a string representation of this construct.

With 
private IConstruct With(params IMixin[] Mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

MixinsRequired
  • Type: params Constructs.IMixin[]

The mixins to apply.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

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

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget 
private void AddMoveTarget(string MoveTarget)

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

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: Io.Cdktn.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
MoveFromId 
private void MoveFromId(string Id)

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.

IdRequired
  • Type: string

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

MoveTo 
private void MoveTo(string MoveTarget, string|double Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

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

IndexOptional
  • Type: string|double

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

MoveToId 
private void MoveToId(string Id)

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

IdRequired
  • Type: string

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

ResetIdentifier 
private void ResetIdentifier()
ResetName 
private void ResetName()
ResetOpacity 
private void ResetOpacity()
ResetPadding 
private void ResetPadding()
ResetPosition 
private void ResetPosition()
ResetScale 
private void ResetScale()
ResetUrl 
private void ResetUrl()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTN code for importing a StreamWatermarkA resource upon running "cdktn plan ".
IsConstruct 
using Io.Cdktn.Providers.Cloudflare;

StreamWatermarkA.IsConstruct(object 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.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using Io.Cdktn.Providers.Cloudflare;

StreamWatermarkA.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using Io.Cdktn.Providers.Cloudflare;

StreamWatermarkA.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using Io.Cdktn.Providers.Cloudflare;

StreamWatermarkA.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTN code for importing a StreamWatermarkA resource upon running "cdktn plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

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

ImportFromIdRequired
  • Type: string

The id of the existing StreamWatermarkA that should be imported.

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

ProviderOptional
  • Type: Io.Cdktn.TerraformProvider

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

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack Io.Cdktn.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata Io.Cdktn.TerraformProviderGeneratorMetadata No description.
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn string[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] No description.
Created string No description.
DownloadedFrom string No description.
Height double No description.
Size double No description.
Uid string No description.
Width double No description.
AccountIdInput string No description.
IdentifierInput string No description.
NameInput string No description.
OpacityInput double No description.
PaddingInput double No description.
PositionInput string No description.
ScaleInput double No description.
UrlInput string No description.
AccountId string No description.
Identifier string No description.
Name string No description.
Opacity double No description.
Padding double No description.
Position string No description.
Scale double No description.
Url string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: Io.Cdktn.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: Io.Cdktn.TerraformProviderGeneratorMetadata
ConnectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection
CountOptional 
public double|TerraformCount Count { get; }
  • Type: double|Io.Cdktn.TerraformCount
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: Io.Cdktn.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: Io.Cdktn.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: Io.Cdktn.TerraformProvider
ProvisionersOptional 
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]
CreatedRequired 
public string Created { get; }
  • Type: string
DownloadedFromRequired 
public string DownloadedFrom { get; }
  • Type: string
HeightRequired 
public double Height { get; }
  • Type: double
SizeRequired 
public double Size { get; }
  • Type: double
UidRequired 
public string Uid { get; }
  • Type: string
WidthRequired 
public double Width { get; }
  • Type: double
AccountIdInputOptional 
public string AccountIdInput { get; }
  • Type: string
IdentifierInputOptional 
public string IdentifierInput { get; }
  • Type: string
NameInputOptional 
public string NameInput { get; }
  • Type: string
OpacityInputOptional 
public double OpacityInput { get; }
  • Type: double
PaddingInputOptional 
public double PaddingInput { get; }
  • Type: double
PositionInputOptional 
public string PositionInput { get; }
  • Type: string
ScaleInputOptional 
public double ScaleInput { get; }
  • Type: double
UrlInputOptional 
public string UrlInput { get; }
  • Type: string
AccountIdRequired 
public string AccountId { get; }
  • Type: string
IdentifierRequired 
public string Identifier { get; }
  • Type: string
NameRequired 
public string Name { get; }
  • Type: string
OpacityRequired 
public double Opacity { get; }
  • Type: double
PaddingRequired 
public double Padding { get; }
  • Type: double
PositionRequired 
public string Position { get; }
  • Type: string
ScaleRequired 
public double Scale { get; }
  • Type: double
UrlRequired 
public string Url { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

StreamWatermarkAConfig

Initializer 

using Io.Cdktn.Providers.Cloudflare;

new StreamWatermarkAConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string AccountId,
    string Identifier = null,
    string Name = null,
    double Opacity = null,
    double Padding = null,
    string Position = null,
    double Scale = null,
    string Url = null
};

Properties

Name Type Description
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn Io.Cdktn.ITerraformDependable[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] No description.
AccountId string The account identifier tag.
Identifier string The unique identifier for a watermark profile.
Name string A short description of the watermark profile.
Opacity double The translucency of the image.
Padding double The whitespace between the adjacent edges (determined by position) of the video and the image.
Position string The location of the image.
Scale double The size of the image relative to the overall size of the video.
Url string URL of the watermark image to copy.
ConnectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection
CountOptional 
public double|TerraformCount Count { get; set; }
  • Type: double|Io.Cdktn.TerraformCount
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: Io.Cdktn.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: Io.Cdktn.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: Io.Cdktn.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: Io.Cdktn.TerraformProvider
ProvisionersOptional 
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]
AccountIdRequired 
public string AccountId { get; set; }
  • Type: string

The account identifier tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/stream_watermark#account_id StreamWatermarkA#account_id}

IdentifierOptional 
public string Identifier { get; set; }
  • Type: string

The unique identifier for a watermark profile.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/stream_watermark#identifier StreamWatermarkA#identifier}

NameOptional 
public string Name { get; set; }
  • Type: string

A short description of the watermark profile.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/stream_watermark#name StreamWatermarkA#name}

OpacityOptional 
public double Opacity { get; set; }
  • Type: double

The translucency of the image.

A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/stream_watermark#opacity StreamWatermarkA#opacity}

PaddingOptional 
public double Padding { get; set; }
  • Type: double

The whitespace between the adjacent edges (determined by position) of the video and the image.

0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/stream_watermark#padding StreamWatermarkA#padding}

PositionOptional 
public string Position { get; set; }
  • Type: string

The location of the image.

Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/stream_watermark#position StreamWatermarkA#position}

ScaleOptional 
public double Scale { get; set; }
  • Type: double

The size of the image relative to the overall size of the video.

This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0 fills the entire video.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/stream_watermark#scale StreamWatermarkA#scale}

UrlOptional 
public string Url { get; set; }
  • Type: string

URL of the watermark image to copy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/stream_watermark#url StreamWatermarkA#url}