`kinesisStream` Submodule

Constructs

KinesisStream

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream aws_kinesis_stream}.

Initializers

using Io.Cdktn.Providers.Aws;

new KinesisStream(Construct Scope, string Id, KinesisStreamConfig Config);

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

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".
`PutStreamModeDetails`	No description.
`PutTimeouts`	No description.
`ResetArn`	No description.
`ResetEncryptionType`	No description.
`ResetEnforceConsumerDeletion`	No description.
`ResetId`	No description.
`ResetKmsKeyId`	No description.
`ResetMaxRecordSizeInKib`	No description.
`ResetRegion`	No description.
`ResetRetentionPeriod`	No description.
`ResetShardCount`	No description.
`ResetShardLevelMetrics`	No description.
`ResetStreamModeDetails`	No description.
`ResetTags`	No description.
`ResetTagsAll`	No description.
`ResetTimeouts`	No description.
`ResetWarmThroughputMibPs`	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.

`Mixins`^Required

Type: params Constructs.IMixin[]

The mixins to apply.

`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 TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()

`ImportFrom`

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

`Id`^Required

Type: string

`Provider`^Optional

Type: Io.Cdktn.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, string|double 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: 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".

`Id`^Required

Type: string

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

`PutStreamModeDetails`

private void PutStreamModeDetails(KinesisStreamStreamModeDetails Value)

`Value`^Required

Type: KinesisStreamStreamModeDetails

`PutTimeouts`

private void PutTimeouts(KinesisStreamTimeouts Value)

`Value`^Required

Type: KinesisStreamTimeouts

`ResetArn`

private void ResetArn()

`ResetEncryptionType`

private void ResetEncryptionType()

`ResetEnforceConsumerDeletion`

private void ResetEnforceConsumerDeletion()

`ResetId`

private void ResetId()

`ResetKmsKeyId`

private void ResetKmsKeyId()

`ResetMaxRecordSizeInKib`

private void ResetMaxRecordSizeInKib()

`ResetRegion`

private void ResetRegion()

`ResetRetentionPeriod`

private void ResetRetentionPeriod()

`ResetShardCount`

private void ResetShardCount()

`ResetShardLevelMetrics`

private void ResetShardLevelMetrics()

`ResetStreamModeDetails`

private void ResetStreamModeDetails()

`ResetTags`

private void ResetTags()

`ResetTagsAll`

private void ResetTagsAll()

`ResetTimeouts`

private void ResetTimeouts()

`ResetWarmThroughputMibPs`

private void ResetWarmThroughputMibPs()

Static Functions

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

`IsConstruct`

using Io.Cdktn.Providers.Aws;

KinesisStream.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 Io.Cdktn.Providers.Aws;

KinesisStream.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using Io.Cdktn.Providers.Aws;

KinesisStream.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using Io.Cdktn.Providers.Aws;

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

Generates CDKTN code for importing a KinesisStream resource upon running "cdktn 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 KinesisStream to import.

`ImportFromId`^Required

Type: string

The id of the existing KinesisStream that should be imported.

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

`Provider`^Optional

Type: Io.Cdktn.TerraformProvider

? Optional instance of the provider where the KinesisStream 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.
`StreamModeDetails`	`KinesisStreamStreamModeDetailsOutputReference`	No description.
`Timeouts`	`KinesisStreamTimeoutsOutputReference`	No description.
`ArnInput`	`string`	No description.
`EncryptionTypeInput`	`string`	No description.
`EnforceConsumerDeletionInput`	`bool\|Io.Cdktn.IResolvable`	No description.
`IdInput`	`string`	No description.
`KmsKeyIdInput`	`string`	No description.
`MaxRecordSizeInKibInput`	`double`	No description.
`NameInput`	`string`	No description.
`RegionInput`	`string`	No description.
`RetentionPeriodInput`	`double`	No description.
`ShardCountInput`	`double`	No description.
`ShardLevelMetricsInput`	`string[]`	No description.
`StreamModeDetailsInput`	`KinesisStreamStreamModeDetails`	No description.
`TagsAllInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TagsInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TimeoutsInput`	`Io.Cdktn.IResolvable\|KinesisStreamTimeouts`	No description.
`WarmThroughputMibPsInput`	`double`	No description.
`Arn`	`string`	No description.
`EncryptionType`	`string`	No description.
`EnforceConsumerDeletion`	`bool\|Io.Cdktn.IResolvable`	No description.
`Id`	`string`	No description.
`KmsKeyId`	`string`	No description.
`MaxRecordSizeInKib`	`double`	No description.
`Name`	`string`	No description.
`Region`	`string`	No description.
`RetentionPeriod`	`double`	No description.
`ShardCount`	`double`	No description.
`ShardLevelMetrics`	`string[]`	No description.
`Tags`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TagsAll`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`WarmThroughputMibPs`	`double`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: Io.Cdktn.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: Io.Cdktn.TerraformProviderGeneratorMetadata

`Connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }

Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

`Count`^Optional

public double|TerraformCount Count { get; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: Io.Cdktn.TerraformProvider

`Provisioners`^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }

Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

`StreamModeDetails`^Required

public KinesisStreamStreamModeDetailsOutputReference StreamModeDetails { get; }

Type: KinesisStreamStreamModeDetailsOutputReference

`Timeouts`^Required

public KinesisStreamTimeoutsOutputReference Timeouts { get; }

Type: KinesisStreamTimeoutsOutputReference

`ArnInput`^Optional

public string ArnInput { get; }

Type: string

`EncryptionTypeInput`^Optional

public string EncryptionTypeInput { get; }

Type: string

`EnforceConsumerDeletionInput`^Optional

public bool|IResolvable EnforceConsumerDeletionInput { get; }

Type: bool|Io.Cdktn.IResolvable

`IdInput`^Optional

public string IdInput { get; }

Type: string

`KmsKeyIdInput`^Optional

public string KmsKeyIdInput { get; }

Type: string

`MaxRecordSizeInKibInput`^Optional

public double MaxRecordSizeInKibInput { get; }

Type: double

`NameInput`^Optional

public string NameInput { get; }

Type: string

`RegionInput`^Optional

public string RegionInput { get; }

Type: string

`RetentionPeriodInput`^Optional

public double RetentionPeriodInput { get; }

Type: double

`ShardCountInput`^Optional

public double ShardCountInput { get; }

Type: double

`ShardLevelMetricsInput`^Optional

public string[] ShardLevelMetricsInput { get; }

Type: string[]

`StreamModeDetailsInput`^Optional

public KinesisStreamStreamModeDetails StreamModeDetailsInput { get; }

Type: KinesisStreamStreamModeDetails

`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 IResolvable|KinesisStreamTimeouts TimeoutsInput { get; }

Type: Io.Cdktn.IResolvable|KinesisStreamTimeouts

`WarmThroughputMibPsInput`^Optional

public double WarmThroughputMibPsInput { get; }

Type: double

`Arn`^Required

public string Arn { get; }

Type: string

`EncryptionType`^Required

public string EncryptionType { get; }

Type: string

`EnforceConsumerDeletion`^Required

public bool|IResolvable EnforceConsumerDeletion { get; }

Type: bool|Io.Cdktn.IResolvable

`Id`^Required

public string Id { get; }

Type: string

`KmsKeyId`^Required

public string KmsKeyId { get; }

Type: string

`MaxRecordSizeInKib`^Required

public double MaxRecordSizeInKib { get; }

Type: double

`Name`^Required

public string Name { get; }

Type: string

`Region`^Required

public string Region { get; }

Type: string

`RetentionPeriod`^Required

public double RetentionPeriod { get; }

Type: double

`ShardCount`^Required

public double ShardCount { get; }

Type: double

`ShardLevelMetrics`^Required

public string[] ShardLevelMetrics { 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>

`WarmThroughputMibPs`^Required

public double WarmThroughputMibPs { get; }

Type: double

Constants

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

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

KinesisStreamConfig

Initializer

using Io.Cdktn.Providers.Aws;

new KinesisStreamConfig {
    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 Name,
    string Arn = null,
    string EncryptionType = null,
    bool|IResolvable EnforceConsumerDeletion = null,
    string Id = null,
    string KmsKeyId = null,
    double MaxRecordSizeInKib = null,
    string Region = null,
    double RetentionPeriod = null,
    double ShardCount = null,
    string[] ShardLevelMetrics = null,
    KinesisStreamStreamModeDetails StreamModeDetails = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null,
    KinesisStreamTimeouts Timeouts = null,
    double WarmThroughputMibPs = 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.
`Name`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#name KinesisStream#name}.
`Arn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#arn KinesisStream#arn}.
`EncryptionType`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#encryption_type KinesisStream#encryption_type}.
`EnforceConsumerDeletion`	`bool\|Io.Cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#enforce_consumer_deletion KinesisStream#enforce_consumer_deletion}.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#id KinesisStream#id}.
`KmsKeyId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#kms_key_id KinesisStream#kms_key_id}.
`MaxRecordSizeInKib`	`double`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#max_record_size_in_kib KinesisStream#max_record_size_in_kib}.
`Region`	`string`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`RetentionPeriod`	`double`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#retention_period KinesisStream#retention_period}.
`ShardCount`	`double`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#shard_count KinesisStream#shard_count}.
`ShardLevelMetrics`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#shard_level_metrics KinesisStream#shard_level_metrics}.
`StreamModeDetails`	`KinesisStreamStreamModeDetails`	stream_mode_details block.
`Tags`	`System.Collections.Generic.IDictionary<string, string>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#tags KinesisStream#tags}.
`TagsAll`	`System.Collections.Generic.IDictionary<string, string>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#tags_all KinesisStream#tags_all}.
`Timeouts`	`KinesisStreamTimeouts`	timeouts block.
`WarmThroughputMibPs`	`double`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#warm_throughput_mib_ps KinesisStream#warm_throughput_mib_ps}.

`Connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }

Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

`Count`^Optional

public double|TerraformCount Count { get; set; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: Io.Cdktn.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: Io.Cdktn.TerraformProvider

`Provisioners`^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }

Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

`Name`^Required

public string Name { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#name KinesisStream#name}.

`Arn`^Optional

public string Arn { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#arn KinesisStream#arn}.

`EncryptionType`^Optional

public string EncryptionType { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#encryption_type KinesisStream#encryption_type}.

`EnforceConsumerDeletion`^Optional

public bool|IResolvable EnforceConsumerDeletion { get; set; }

Type: bool|Io.Cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#enforce_consumer_deletion KinesisStream#enforce_consumer_deletion}.

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#id KinesisStream#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.

`KmsKeyId`^Optional

public string KmsKeyId { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#kms_key_id KinesisStream#kms_key_id}.

`MaxRecordSizeInKib`^Optional

public double MaxRecordSizeInKib { get; set; }

Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#max_record_size_in_kib KinesisStream#max_record_size_in_kib}.

`Region`^Optional

public string Region { get; set; }

Type: string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#region KinesisStream#region}

`RetentionPeriod`^Optional

public double RetentionPeriod { get; set; }

Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#retention_period KinesisStream#retention_period}.

`ShardCount`^Optional

public double ShardCount { get; set; }

Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#shard_count KinesisStream#shard_count}.

`ShardLevelMetrics`^Optional

public string[] ShardLevelMetrics { get; set; }

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#shard_level_metrics KinesisStream#shard_level_metrics}.

`StreamModeDetails`^Optional

public KinesisStreamStreamModeDetails StreamModeDetails { get; set; }

Type: KinesisStreamStreamModeDetails

stream_mode_details block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#stream_mode_details KinesisStream#stream_mode_details}

`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/6.55.0/docs/resources/kinesis_stream#tags KinesisStream#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/6.55.0/docs/resources/kinesis_stream#tags_all KinesisStream#tags_all}.

`Timeouts`^Optional

public KinesisStreamTimeouts Timeouts { get; set; }

Type: KinesisStreamTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#timeouts KinesisStream#timeouts}

`WarmThroughputMibPs`^Optional

public double WarmThroughputMibPs { get; set; }

Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#warm_throughput_mib_ps KinesisStream#warm_throughput_mib_ps}.

KinesisStreamStreamModeDetails

Initializer

using Io.Cdktn.Providers.Aws;

new KinesisStreamStreamModeDetails {
    string StreamMode
};

Properties

Name	Type	Description
`StreamMode`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#stream_mode KinesisStream#stream_mode}.

`StreamMode`^Required

public string StreamMode { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#stream_mode KinesisStream#stream_mode}.

KinesisStreamTimeouts

Initializer

using Io.Cdktn.Providers.Aws;

new KinesisStreamTimeouts {
    string Create = null,
    string Delete = null,
    string Update = null
};

Properties

Name	Type	Description
`Create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#create KinesisStream#create}.
`Delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#delete KinesisStream#delete}.
`Update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#update KinesisStream#update}.

`Create`^Optional

public string Create { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#create KinesisStream#create}.

`Delete`^Optional

public string Delete { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#delete KinesisStream#delete}.

`Update`^Optional

public string Update { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/kinesis_stream#update KinesisStream#update}.

Classes

KinesisStreamStreamModeDetailsOutputReference

Initializers

using Io.Cdktn.Providers.Aws;

new KinesisStreamStreamModeDetailsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

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

`TerraformResource`^Required

Type: Io.Cdktn.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`

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: Io.Cdktn.IResolveContext

`ToString`

private string ToString()

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.
`StreamModeInput`	`string`	No description.
`StreamMode`	`string`	No description.
`InternalValue`	`KinesisStreamStreamModeDetails`	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

`StreamModeInput`^Optional

public string StreamModeInput { get; }

Type: string

`StreamMode`^Required

public string StreamMode { get; }

Type: string

`InternalValue`^Optional

public KinesisStreamStreamModeDetails InternalValue { get; }

Type: KinesisStreamStreamModeDetails

KinesisStreamTimeoutsOutputReference

Initializers

using Io.Cdktn.Providers.Aws;

new KinesisStreamTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

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

`TerraformResource`^Required

Type: Io.Cdktn.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.
`ResetUpdate`	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: Io.Cdktn.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()

`ResetUpdate`

private void ResetUpdate()

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.
`UpdateInput`	`string`	No description.
`Create`	`string`	No description.
`Delete`	`string`	No description.
`Update`	`string`	No description.
`InternalValue`	`Io.Cdktn.IResolvable\|KinesisStreamTimeouts`	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

`UpdateInput`^Optional

public string UpdateInput { get; }

Type: string

`Create`^Required

public string Create { get; }

Type: string

`Delete`^Required

public string Delete { get; }

Type: string

`Update`^Required

public string Update { get; }

Type: string

`InternalValue`^Optional

public IResolvable|KinesisStreamTimeouts InternalValue { get; }

Type: Io.Cdktn.IResolvable|KinesisStreamTimeouts

Uh oh!

FilesExpand file tree

kinesisStream.csharp.md

Latest commit

History

kinesisStream.csharp.md

File metadata and controls

kinesisStream Submodule

Constructs

KinesisStream

Initializers

ScopeRequired

IdRequired

ConfigRequired

Methods

ToString

With

MixinsRequired

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

PutStreamModeDetails

ValueRequired

PutTimeouts

ValueRequired

ResetArn

ResetEncryptionType

ResetEnforceConsumerDeletion

ResetId

ResetKmsKeyId

ResetMaxRecordSizeInKib

ResetRegion

ResetRetentionPeriod

ResetShardCount

ResetShardLevelMetrics

ResetStreamModeDetails

ResetTags

ResetTagsAll

ResetTimeouts

ResetWarmThroughputMibPs

Static Functions

`kinesisStream` Submodule

`Scope`^Required

`Id`^Required

`Config`^Required

`ToString`

`With`

`Mixins`^Required

`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

`PutStreamModeDetails`

`Value`^Required

`PutTimeouts`

`Value`^Required

`ResetArn`

`ResetEncryptionType`

`ResetEnforceConsumerDeletion`

`ResetId`

`ResetKmsKeyId`

`ResetMaxRecordSizeInKib`

`ResetRegion`

`ResetRetentionPeriod`

`ResetShardCount`

`ResetShardLevelMetrics`

`ResetStreamModeDetails`

`ResetTags`

`ResetTagsAll`

`ResetTimeouts`

`ResetWarmThroughputMibPs`

`IsConstruct`

`X`^Required

`IsTerraformElement`

`X`^Required

`IsTerraformResource`

`X`^Required

`GenerateConfigForImport`

`Scope`^Required

`ImportToId`^Required

`ImportFromId`^Required

`Provider`^Optional

`Node`^Required