offset

README

time_offset

Refer to the Terraform Registory for docs: time_offset.

Documentation

Index

• func NewOffset_Override(o Offset, scope constructs.Construct, id *string, config *OffsetConfig)
• func Offset_IsConstruct(x interface{}) *bool
• func Offset_IsTerraformElement(x interface{}) *bool
• func Offset_IsTerraformResource(x interface{}) *bool
• func Offset_TfResourceType() *string
• type Offset
  • func NewOffset(scope constructs.Construct, id *string, config *OffsetConfig) Offset
• type OffsetConfig

Functions

func NewOffset_Override

func NewOffset_Override(o Offset, scope constructs.Construct, id *string, config *OffsetConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/time/0.9.1/docs/resources/offset time_offset} Resource.

func Offset_IsConstruct

func Offset_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func Offset_IsTerraformElement

func Offset_IsTerraformElement(x interface{}) *bool

Experimental.

func Offset_IsTerraformResource

func Offset_IsTerraformResource(x interface{}) *bool

Experimental.

func Offset_TfResourceType

func Offset_TfResourceType() *string

Types

type Offset

type Offset interface {
	cdktf.TerraformResource
	BaseRfc3339() *string
	SetBaseRfc3339(val *string)
	BaseRfc3339Input() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	Day() *float64
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Hour() *float64
	Id() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Minute() *float64
	Month() *float64
	// The tree node.
	Node() constructs.Node
	OffsetDays() *float64
	SetOffsetDays(val *float64)
	OffsetDaysInput() *float64
	OffsetHours() *float64
	SetOffsetHours(val *float64)
	OffsetHoursInput() *float64
	OffsetMinutes() *float64
	SetOffsetMinutes(val *float64)
	OffsetMinutesInput() *float64
	OffsetMonths() *float64
	SetOffsetMonths(val *float64)
	OffsetMonthsInput() *float64
	OffsetSeconds() *float64
	SetOffsetSeconds(val *float64)
	OffsetSecondsInput() *float64
	OffsetYears() *float64
	SetOffsetYears(val *float64)
	OffsetYearsInput() *float64
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	Rfc3339() *string
	Second() *float64
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Triggers() *map[string]*string
	SetTriggers(val *map[string]*string)
	TriggersInput() *map[string]*string
	Unix() *float64
	Year() *float64
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetBaseRfc3339()
	ResetOffsetDays()
	ResetOffsetHours()
	ResetOffsetMinutes()
	ResetOffsetMonths()
	ResetOffsetSeconds()
	ResetOffsetYears()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetTriggers()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

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

func NewOffset

func NewOffset(scope constructs.Construct, id *string, config *OffsetConfig) Offset

Create a new {@link https://registry.terraform.io/providers/hashicorp/time/0.9.1/docs/resources/offset time_offset} Resource.

type OffsetConfig

type OffsetConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// Base timestamp in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (see [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) 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.9.1/docs/resources/offset#base_rfc3339 Offset#base_rfc3339}
	BaseRfc3339 *string `field:"optional" json:"baseRfc3339" yaml:"baseRfc3339"`
	// 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.9.1/docs/resources/offset#offset_days Offset#offset_days}
	OffsetDays *float64 `field:"optional" json:"offsetDays" yaml:"offsetDays"`
	// 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.9.1/docs/resources/offset#offset_hours Offset#offset_hours}
	OffsetHours *float64 `field:"optional" json:"offsetHours" yaml:"offsetHours"`
	// 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.9.1/docs/resources/offset#offset_minutes Offset#offset_minutes}
	OffsetMinutes *float64 `field:"optional" json:"offsetMinutes" yaml:"offsetMinutes"`
	// 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.9.1/docs/resources/offset#offset_months Offset#offset_months}
	OffsetMonths *float64 `field:"optional" json:"offsetMonths" yaml:"offsetMonths"`
	// 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.9.1/docs/resources/offset#offset_seconds Offset#offset_seconds}
	OffsetSeconds *float64 `field:"optional" json:"offsetSeconds" yaml:"offsetSeconds"`
	// 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.9.1/docs/resources/offset#offset_years Offset#offset_years}
	OffsetYears *float64 `field:"optional" json:"offsetYears" yaml:"offsetYears"`
	// Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved.
	//
	// See [the main provider documentation](../index.md) for more information.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/time/0.9.1/docs/resources/offset#triggers Offset#triggers}
	Triggers *map[string]*string `field:"optional" json:"triggers" yaml:"triggers"`
}