`ivsPlaybackKeyPair` Submodule

Constructs

IvsPlaybackKeyPair

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair aws_ivs_playback_key_pair}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new IvsPlaybackKeyPair(Construct Scope, string Id, IvsPlaybackKeyPairConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`IvsPlaybackKeyPairConfig`	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: IvsPlaybackKeyPairConfig

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".
`PutTimeouts`	No description.
`ResetId`	No description.
`ResetName`	No description.
`ResetTags`	No description.
`ResetTagsAll`	No description.
`ResetTimeouts`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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`

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.

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

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.

`Id`^Required

Type: string

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

`MoveTo`

private void MoveTo(string MoveTarget, object Index = null)

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: object

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

`Id`^Required

Type: string

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

`PutTimeouts`

private void PutTimeouts(IvsPlaybackKeyPairTimeouts Value)

`Value`^Required

Type: IvsPlaybackKeyPairTimeouts

`ResetId`

private void ResetId()

`ResetName`

private void ResetName()

`ResetTags`

private void ResetTags()

`ResetTagsAll`

private void ResetTagsAll()

`ResetTimeouts`

private void ResetTimeouts()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a IvsPlaybackKeyPair resource upon running "cdktf plan ".

`IsConstruct`

using HashiCorp.Cdktf.Providers.Aws;

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

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Aws;

IvsPlaybackKeyPair.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Aws;

IvsPlaybackKeyPair.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Aws;

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

Generates CDKTF code for importing a IvsPlaybackKeyPair 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 IvsPlaybackKeyPair to import.

`ImportFromId`^Required

Type: string

The id of the existing IvsPlaybackKeyPair that should be imported.

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

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`HashiCorp.Cdktf.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`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Arn`	`string`	No description.
`Fingerprint`	`string`	No description.
`Timeouts`	`IvsPlaybackKeyPairTimeoutsOutputReference`	No description.
`IdInput`	`string`	No description.
`NameInput`	`string`	No description.
`PublicKeyInput`	`string`	No description.
`TagsAllInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TagsInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TimeoutsInput`	`object`	No description.
`Id`	`string`	No description.
`Name`	`string`	No description.
`PublicKey`	`string`	No description.
`Tags`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TagsAll`	`System.Collections.Generic.IDictionary<string, string>`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`Arn`^Required

public string Arn { get; }

Type: string

`Fingerprint`^Required

public string Fingerprint { get; }

Type: string

`Timeouts`^Required

public IvsPlaybackKeyPairTimeoutsOutputReference Timeouts { get; }

Type: IvsPlaybackKeyPairTimeoutsOutputReference

`IdInput`^Optional

public string IdInput { get; }

Type: string

`NameInput`^Optional

public string NameInput { get; }

Type: string

`PublicKeyInput`^Optional

public string PublicKeyInput { get; }

Type: string

`TagsAllInput`^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`TagsInput`^Optional

public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`TimeoutsInput`^Optional

public object TimeoutsInput { get; }

Type: object

`Id`^Required

public string Id { get; }

Type: string

`Name`^Required

public string Name { get; }

Type: string

`PublicKey`^Required

public string PublicKey { get; }

Type: string

`Tags`^Required

public System.Collections.Generic.IDictionary<string, string> Tags { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`TagsAll`^Required

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }

Type: System.Collections.Generic.IDictionary<string, string>

Constants

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

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

IvsPlaybackKeyPairConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new IvsPlaybackKeyPairConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string PublicKey,
    string Id = null,
    string Name = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null,
    IvsPlaybackKeyPairTimeouts Timeouts = null
};

Properties

Name	Type	Description
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`HashiCorp.Cdktf.ITerraformDependable[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`PublicKey`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#public_key IvsPlaybackKeyPair#public_key}.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#id IvsPlaybackKeyPair#id}.
`Name`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#name IvsPlaybackKeyPair#name}.
`Tags`	`System.Collections.Generic.IDictionary<string, string>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#tags IvsPlaybackKeyPair#tags}.
`TagsAll`	`System.Collections.Generic.IDictionary<string, string>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#tags_all IvsPlaybackKeyPair#tags_all}.
`Timeouts`	`IvsPlaybackKeyPairTimeouts`	timeouts block.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`PublicKey`^Required

public string PublicKey { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#public_key IvsPlaybackKeyPair#public_key}.

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#id IvsPlaybackKeyPair#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`Name`^Optional

public string Name { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#name IvsPlaybackKeyPair#name}.

`Tags`^Optional

public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }

Type: System.Collections.Generic.IDictionary<string, string>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#tags IvsPlaybackKeyPair#tags}.

`TagsAll`^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; set; }

Type: System.Collections.Generic.IDictionary<string, string>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#tags_all IvsPlaybackKeyPair#tags_all}.

`Timeouts`^Optional

public IvsPlaybackKeyPairTimeouts Timeouts { get; set; }

Type: IvsPlaybackKeyPairTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#timeouts IvsPlaybackKeyPair#timeouts}

IvsPlaybackKeyPairTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new IvsPlaybackKeyPairTimeouts {
    string Create = null,
    string Delete = null
};

Properties

Name	Type	Description
`Create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#create IvsPlaybackKeyPair#create}.
`Delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#delete IvsPlaybackKeyPair#delete}.

`Create`^Optional

public string Create { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#create IvsPlaybackKeyPair#create}.

`Delete`^Optional

public string Delete { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/ivs_playback_key_pair#delete IvsPlaybackKeyPair#delete}.

Classes

IvsPlaybackKeyPairTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new IvsPlaybackKeyPairTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`TerraformResource`^Required

Type: HashiCorp.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.
`ResetCreate`	No description.
`ResetDelete`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetCreate`

private void ResetCreate()

`ResetDelete`

private void ResetDelete()

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.
`CreateInput`	`string`	No description.
`DeleteInput`	`string`	No description.
`Create`	`string`	No description.
`Delete`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

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 string Fqn { get; }

Type: string

`CreateInput`^Optional

public string CreateInput { get; }

Type: string

`DeleteInput`^Optional

public string DeleteInput { get; }

Type: string

`Create`^Required

public string Create { get; }

Type: string

`Delete`^Required

public string Delete { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

Files

ivsPlaybackKeyPair.csharp.md

Latest commit

History

ivsPlaybackKeyPair.csharp.md

File metadata and controls

ivsPlaybackKeyPair Submodule

Constructs