`offset` Submodule

Constructs

Offset

Represents a {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset time_offset}.

Initializers

using HashiCorp.Cdktf.Providers.Time;

new Offset(Construct Scope, string Id, OffsetConfig Config = null);

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

Type: OffsetConfig

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".
`ResetBaseRfc3339`	No description.
`ResetOffsetDays`	No description.
`ResetOffsetHours`	No description.
`ResetOffsetMinutes`	No description.
`ResetOffsetMonths`	No description.
`ResetOffsetSeconds`	No description.
`ResetOffsetYears`	No description.
`ResetTriggers`	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".

`ResetBaseRfc3339`

private void ResetBaseRfc3339()

`ResetOffsetDays`

private void ResetOffsetDays()

`ResetOffsetHours`

private void ResetOffsetHours()

`ResetOffsetMinutes`

private void ResetOffsetMinutes()

`ResetOffsetMonths`

private void ResetOffsetMonths()

`ResetOffsetSeconds`

private void ResetOffsetSeconds()

`ResetOffsetYears`

private void ResetOffsetYears()

`ResetTriggers`

private void ResetTriggers()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Time;

Offset.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.Time;

Offset.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Time;

Offset.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Time;

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

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

`ImportFromId`^Required

Type: string

The id of the existing Offset that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset#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 Offset 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.
`Day`	`double`	No description.
`Hour`	`double`	No description.
`Id`	`string`	No description.
`Minute`	`double`	No description.
`Month`	`double`	No description.
`Rfc3339`	`string`	No description.
`Second`	`double`	No description.
`Unix`	`double`	No description.
`Year`	`double`	No description.
`BaseRfc3339Input`	`string`	No description.
`OffsetDaysInput`	`double`	No description.
`OffsetHoursInput`	`double`	No description.
`OffsetMinutesInput`	`double`	No description.
`OffsetMonthsInput`	`double`	No description.
`OffsetSecondsInput`	`double`	No description.
`OffsetYearsInput`	`double`	No description.
`TriggersInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`BaseRfc3339`	`string`	No description.
`OffsetDays`	`double`	No description.
`OffsetHours`	`double`	No description.
`OffsetMinutes`	`double`	No description.
`OffsetMonths`	`double`	No description.
`OffsetSeconds`	`double`	No description.
`OffsetYears`	`double`	No description.
`Triggers`	`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[]

`Day`^Required

public double Day { get; }

Type: double

`Hour`^Required

public double Hour { get; }

Type: double

`Id`^Required

public string Id { get; }

Type: string

`Minute`^Required

public double Minute { get; }

Type: double

`Month`^Required

public double Month { get; }

Type: double

`Rfc3339`^Required

public string Rfc3339 { get; }

Type: string

`Second`^Required

public double Second { get; }

Type: double

`Unix`^Required

public double Unix { get; }

Type: double

`Year`^Required

public double Year { get; }

Type: double

`BaseRfc3339Input`^Optional

public string BaseRfc3339Input { get; }

Type: string

`OffsetDaysInput`^Optional

public double OffsetDaysInput { get; }

Type: double

`OffsetHoursInput`^Optional

public double OffsetHoursInput { get; }

Type: double

`OffsetMinutesInput`^Optional

public double OffsetMinutesInput { get; }

Type: double

`OffsetMonthsInput`^Optional

public double OffsetMonthsInput { get; }

Type: double

`OffsetSecondsInput`^Optional

public double OffsetSecondsInput { get; }

Type: double

`OffsetYearsInput`^Optional

public double OffsetYearsInput { get; }

Type: double

`TriggersInput`^Optional

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

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

`BaseRfc3339`^Required

public string BaseRfc3339 { get; }

Type: string

`OffsetDays`^Required

public double OffsetDays { get; }

Type: double

`OffsetHours`^Required

public double OffsetHours { get; }

Type: double

`OffsetMinutes`^Required

public double OffsetMinutes { get; }

Type: double

`OffsetMonths`^Required

public double OffsetMonths { get; }

Type: double

`OffsetSeconds`^Required

public double OffsetSeconds { get; }

Type: double

`OffsetYears`^Required

public double OffsetYears { get; }

Type: double

`Triggers`^Required

public System.Collections.Generic.IDictionary<string, string> Triggers { 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

OffsetConfig

Initializer

using HashiCorp.Cdktf.Providers.Time;

new OffsetConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string BaseRfc3339 = null,
    double OffsetDays = null,
    double OffsetHours = null,
    double OffsetMinutes = null,
    double OffsetMonths = null,
    double OffsetSeconds = null,
    double OffsetYears = null,
    System.Collections.Generic.IDictionary<string, string> Triggers = 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.
`BaseRfc3339`	`string`	Base timestamp in RFC3339 format (see RFC3339 time string e.g., `YYYY-MM-DDTHH:MM:SSZ`). Defaults to the current time.
`OffsetDays`	`double`	Number of days to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
`OffsetHours`	`double`	Number of hours to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
`OffsetMinutes`	`double`	Number of minutes to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
`OffsetMonths`	`double`	Number of months to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
`OffsetSeconds`	`double`	Number of seconds to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
`OffsetYears`	`double`	Number of years to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
`Triggers`	`System.Collections.Generic.IDictionary<string, string>`	Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved.

`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[]

`BaseRfc3339`^Optional

public string BaseRfc3339 { get; set; }

Type: string

Base timestamp in RFC3339 format (see RFC3339 time string e.g., YYYY-MM-DDTHH:MM:SSZ). Defaults to the current time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset#base_rfc3339 Offset#base_rfc3339}

`OffsetDays`^Optional

public double OffsetDays { get; set; }

Type: double

Number of days to offset the base timestamp. At least one of the 'offset_' arguments must be configured.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset#offset_days Offset#offset_days}

`OffsetHours`^Optional

public double OffsetHours { get; set; }

Type: double

Number of hours to offset the base timestamp. At least one of the 'offset_' arguments must be configured.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset#offset_hours Offset#offset_hours}

`OffsetMinutes`^Optional

public double OffsetMinutes { get; set; }

Type: double

Number of minutes to offset the base timestamp. At least one of the 'offset_' arguments must be configured.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset#offset_minutes Offset#offset_minutes}

`OffsetMonths`^Optional

public double OffsetMonths { get; set; }

Type: double

Number of months to offset the base timestamp. At least one of the 'offset_' arguments must be configured.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset#offset_months Offset#offset_months}

`OffsetSeconds`^Optional

public double OffsetSeconds { get; set; }

Type: double

Number of seconds to offset the base timestamp. At least one of the 'offset_' arguments must be configured.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset#offset_seconds Offset#offset_seconds}

`OffsetYears`^Optional

public double OffsetYears { get; set; }

Type: double

Number of years to offset the base timestamp. At least one of the 'offset_' arguments must be configured.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset#offset_years Offset#offset_years}

`Triggers`^Optional

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

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

Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved.

See the main provider documentation for more information.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/time/0.12.1/docs/resources/offset#triggers Offset#triggers}

Files

offset.csharp.md

Latest commit

History

offset.csharp.md

File metadata and controls

offset Submodule

Constructs

Offset

Initializers

ScopeRequired

IdRequired

ConfigOptional

Methods

ToString

AddOverride

PathRequired

ValueRequired

OverrideLogicalId

NewLogicalIdRequired

ResetOverrideLogicalId

ToHclTerraform

ToMetadata

ToTerraform

AddMoveTarget

MoveTargetRequired

GetAnyMapAttribute

TerraformAttributeRequired

GetBooleanAttribute

TerraformAttributeRequired

GetBooleanMapAttribute

TerraformAttributeRequired

GetListAttribute

TerraformAttributeRequired

GetNumberAttribute

TerraformAttributeRequired

GetNumberListAttribute

TerraformAttributeRequired

GetNumberMapAttribute

TerraformAttributeRequired

GetStringAttribute

TerraformAttributeRequired

GetStringMapAttribute

TerraformAttributeRequired

HasResourceMove

ImportFrom

IdRequired

ProviderOptional

InterpolationForAttribute

TerraformAttributeRequired

MoveFromId

IdRequired

MoveTo

MoveTargetRequired

IndexOptional

MoveToId

IdRequired

ResetBaseRfc3339

ResetOffsetDays

ResetOffsetHours

ResetOffsetMinutes

ResetOffsetMonths

ResetOffsetSeconds

ResetOffsetYears

ResetTriggers

Static Functions

IsConstruct

XRequired

IsTerraformElement

XRequired

IsTerraformResource

XRequired

GenerateConfigForImport

ScopeRequired

ImportToIdRequired

ImportFromIdRequired

ProviderOptional

Properties

NodeRequired

CdktfStackRequired

`offset` Submodule

`Scope`^Required

`Id`^Required

`Config`^Optional

`ToString`

`AddOverride`

`Path`^Required

`Value`^Required

`OverrideLogicalId`

`NewLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`AddMoveTarget`

`MoveTarget`^Required

`GetAnyMapAttribute`

`TerraformAttribute`^Required

`GetBooleanAttribute`

`TerraformAttribute`^Required

`GetBooleanMapAttribute`

`TerraformAttribute`^Required

`GetListAttribute`

`TerraformAttribute`^Required

`GetNumberAttribute`

`TerraformAttribute`^Required

`GetNumberListAttribute`

`TerraformAttribute`^Required

`GetNumberMapAttribute`

`TerraformAttribute`^Required

`GetStringAttribute`

`TerraformAttribute`^Required

`GetStringMapAttribute`

`TerraformAttribute`^Required

`HasResourceMove`

`ImportFrom`

`Id`^Required

`Provider`^Optional

`InterpolationForAttribute`

`TerraformAttribute`^Required

`MoveFromId`

`Id`^Required

`MoveTo`

`MoveTarget`^Required

`Index`^Optional

`MoveToId`

`Id`^Required

`ResetBaseRfc3339`

`ResetOffsetDays`

`ResetOffsetHours`

`ResetOffsetMinutes`

`ResetOffsetMonths`

`ResetOffsetSeconds`

`ResetOffsetYears`

`ResetTriggers`

`IsConstruct`

`X`^Required

`IsTerraformElement`

`X`^Required

`IsTerraformResource`

`X`^Required

`GenerateConfigForImport`

`Scope`^Required

`ImportToId`^Required

`ImportFromId`^Required

`Provider`^Optional

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`TerraformMetaArguments`^Required

`TerraformResourceType`^Required

`TerraformGeneratorMetadata`^Optional

`Connection`^Optional

`Count`^Optional

`DependsOn`^Optional

`ForEach`^Optional

`Lifecycle`^Optional

`Provider`^Optional

`Provisioners`^Optional