Skip to content

Latest commit

 

History

History
1353 lines (850 loc) · 57.7 KB

dmsReplicationTask.csharp.md

File metadata and controls

1353 lines (850 loc) · 57.7 KB

dmsReplicationTask Submodule

Constructs

DmsReplicationTask

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task aws_dms_replication_task}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DmsReplicationTask(Construct Scope, string Id, DmsReplicationTaskConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DmsReplicationTaskConfig 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.
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".
ResetCdcStartPosition No description.
ResetCdcStartTime No description.
ResetId No description.
ResetReplicationTaskSettings No description.
ResetResourceIdentifier No description.
ResetStartReplicationTask No description.
ResetTags No description.
ResetTagsAll No description.

ToString
private string ToString()

Returns a string representation of this construct.

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 object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.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, object 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: 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".

IdRequired
  • Type: string

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


ResetCdcStartPosition
private void ResetCdcStartPosition()
ResetCdcStartTime
private void ResetCdcStartTime()
ResetId
private void ResetId()
ResetReplicationTaskSettings
private void ResetReplicationTaskSettings()
ResetResourceIdentifier
private void ResetResourceIdentifier()
ResetStartReplicationTask
private void ResetStartReplicationTask()
ResetTags
private void ResetTags()
ResetTagsAll
private void ResetTagsAll()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

DmsReplicationTask.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 HashiCorp.Cdktf.Providers.Aws;

DmsReplicationTask.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using HashiCorp.Cdktf.Providers.Aws;

DmsReplicationTask.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

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

Generates CDKTF code for importing a DmsReplicationTask resource upon running "cdktf 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 DmsReplicationTask to import.


ImportFromIdRequired
  • Type: string

The id of the existing DmsReplicationTask that should be imported.

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


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the DmsReplicationTask 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.
ReplicationTaskArn string No description.
Status string No description.
CdcStartPositionInput string No description.
CdcStartTimeInput string No description.
IdInput string No description.
MigrationTypeInput string No description.
ReplicationInstanceArnInput string No description.
ReplicationTaskIdInput string No description.
ReplicationTaskSettingsInput string No description.
ResourceIdentifierInput string No description.
SourceEndpointArnInput string No description.
StartReplicationTaskInput object No description.
TableMappingsInput string No description.
TagsAllInput System.Collections.Generic.IDictionary<string, string> No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
TargetEndpointArnInput string No description.
CdcStartPosition string No description.
CdcStartTime string No description.
Id string No description.
MigrationType string No description.
ReplicationInstanceArn string No description.
ReplicationTaskId string No description.
ReplicationTaskSettings string No description.
ResourceIdentifier string No description.
SourceEndpointArn string No description.
StartReplicationTask object No description.
TableMappings string No description.
Tags System.Collections.Generic.IDictionary<string, string> No description.
TagsAll System.Collections.Generic.IDictionary<string, string> No description.
TargetEndpointArn string No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.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: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

ReplicationTaskArnRequired
public string ReplicationTaskArn { get; }
  • Type: string

StatusRequired
public string Status { get; }
  • Type: string

CdcStartPositionInputOptional
public string CdcStartPositionInput { get; }
  • Type: string

CdcStartTimeInputOptional
public string CdcStartTimeInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

MigrationTypeInputOptional
public string MigrationTypeInput { get; }
  • Type: string

ReplicationInstanceArnInputOptional
public string ReplicationInstanceArnInput { get; }
  • Type: string

ReplicationTaskIdInputOptional
public string ReplicationTaskIdInput { get; }
  • Type: string

ReplicationTaskSettingsInputOptional
public string ReplicationTaskSettingsInput { get; }
  • Type: string

ResourceIdentifierInputOptional
public string ResourceIdentifierInput { get; }
  • Type: string

SourceEndpointArnInputOptional
public string SourceEndpointArnInput { get; }
  • Type: string

StartReplicationTaskInputOptional
public object StartReplicationTaskInput { get; }
  • Type: object

TableMappingsInputOptional
public string TableMappingsInput { get; }
  • Type: string

TagsAllInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TagsInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TargetEndpointArnInputOptional
public string TargetEndpointArnInput { get; }
  • Type: string

CdcStartPositionRequired
public string CdcStartPosition { get; }
  • Type: string

CdcStartTimeRequired
public string CdcStartTime { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

MigrationTypeRequired
public string MigrationType { get; }
  • Type: string

ReplicationInstanceArnRequired
public string ReplicationInstanceArn { get; }
  • Type: string

ReplicationTaskIdRequired
public string ReplicationTaskId { get; }
  • Type: string

ReplicationTaskSettingsRequired
public string ReplicationTaskSettings { get; }
  • Type: string

ResourceIdentifierRequired
public string ResourceIdentifier { get; }
  • Type: string

SourceEndpointArnRequired
public string SourceEndpointArn { get; }
  • Type: string

StartReplicationTaskRequired
public object StartReplicationTask { get; }
  • Type: object

TableMappingsRequired
public string TableMappings { get; }
  • Type: string

TagsRequired
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TagsAllRequired
public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TargetEndpointArnRequired
public string TargetEndpointArn { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

DmsReplicationTaskConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DmsReplicationTaskConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string MigrationType,
    string ReplicationInstanceArn,
    string ReplicationTaskId,
    string SourceEndpointArn,
    string TableMappings,
    string TargetEndpointArn,
    string CdcStartPosition = null,
    string CdcStartTime = null,
    string Id = null,
    string ReplicationTaskSettings = null,
    string ResourceIdentifier = null,
    object StartReplicationTask = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = 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.
MigrationType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#migration_type DmsReplicationTask#migration_type}.
ReplicationInstanceArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#replication_instance_arn DmsReplicationTask#replication_instance_arn}.
ReplicationTaskId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#replication_task_id DmsReplicationTask#replication_task_id}.
SourceEndpointArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#source_endpoint_arn DmsReplicationTask#source_endpoint_arn}.
TableMappings string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#table_mappings DmsReplicationTask#table_mappings}.
TargetEndpointArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#target_endpoint_arn DmsReplicationTask#target_endpoint_arn}.
CdcStartPosition string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#cdc_start_position DmsReplicationTask#cdc_start_position}.
CdcStartTime string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#cdc_start_time DmsReplicationTask#cdc_start_time}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#id DmsReplicationTask#id}.
ReplicationTaskSettings string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#replication_task_settings DmsReplicationTask#replication_task_settings}.
ResourceIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#resource_identifier DmsReplicationTask#resource_identifier}.
StartReplicationTask object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#start_replication_task DmsReplicationTask#start_replication_task}.
Tags System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#tags DmsReplicationTask#tags}.
TagsAll System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#tags_all DmsReplicationTask#tags_all}.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

MigrationTypeRequired
public string MigrationType { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#migration_type DmsReplicationTask#migration_type}.


ReplicationInstanceArnRequired
public string ReplicationInstanceArn { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#replication_instance_arn DmsReplicationTask#replication_instance_arn}.


ReplicationTaskIdRequired
public string ReplicationTaskId { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#replication_task_id DmsReplicationTask#replication_task_id}.


SourceEndpointArnRequired
public string SourceEndpointArn { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#source_endpoint_arn DmsReplicationTask#source_endpoint_arn}.


TableMappingsRequired
public string TableMappings { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#table_mappings DmsReplicationTask#table_mappings}.


TargetEndpointArnRequired
public string TargetEndpointArn { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#target_endpoint_arn DmsReplicationTask#target_endpoint_arn}.


CdcStartPositionOptional
public string CdcStartPosition { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#cdc_start_position DmsReplicationTask#cdc_start_position}.


CdcStartTimeOptional
public string CdcStartTime { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#cdc_start_time DmsReplicationTask#cdc_start_time}.


IdOptional
public string Id { get; set; }
  • Type: string

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


ReplicationTaskSettingsOptional
public string ReplicationTaskSettings { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#replication_task_settings DmsReplicationTask#replication_task_settings}.


ResourceIdentifierOptional
public string ResourceIdentifier { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#resource_identifier DmsReplicationTask#resource_identifier}.


StartReplicationTaskOptional
public object StartReplicationTask { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/dms_replication_task#start_replication_task DmsReplicationTask#start_replication_task}.


TagsOptional
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.58.0/docs/resources/dms_replication_task#tags DmsReplicationTask#tags}.


TagsAllOptional
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.58.0/docs/resources/dms_replication_task#tags_all DmsReplicationTask#tags_all}.