pulumi-time
Version:
A Pulumi provider for managing time-based resources and operations, dynamically bridged from the Terraform Time provider with support for delays, offsets, rotations, and time-based scheduling.
209 lines (208 loc) • 8.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
export declare class Offset extends pulumi.CustomResource {
/**
* Get an existing Offset resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OffsetState, opts?: pulumi.CustomResourceOptions): Offset;
/**
* Returns true if the given object is an instance of Offset. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Offset;
/**
* 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.
*/
readonly baseRfc3339: pulumi.Output<string>;
/**
* Number day of offset timestamp.
*/
readonly day: pulumi.Output<number>;
/**
* Number hour of offset timestamp.
*/
readonly hour: pulumi.Output<number>;
/**
* Number minute of offset timestamp.
*/
readonly minute: pulumi.Output<number>;
/**
* Number month of offset timestamp.
*/
readonly month: pulumi.Output<number>;
/**
* Number of days to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
readonly offsetDays: pulumi.Output<number | undefined>;
/**
* Number of hours to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
readonly offsetHours: pulumi.Output<number | undefined>;
/**
* Number of minutes to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
readonly offsetMinutes: pulumi.Output<number | undefined>;
/**
* Number of months to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
readonly offsetMonths: pulumi.Output<number | undefined>;
/**
* Number of seconds to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
readonly offsetSeconds: pulumi.Output<number | undefined>;
/**
* Number of years to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
readonly offsetYears: pulumi.Output<number | undefined>;
/**
* RFC3339 format of the offset timestamp, e.g. `2020-02-12T06:36:13Z`.
*/
readonly rfc3339: pulumi.Output<string>;
/**
* Number second of offset timestamp.
*/
readonly second: pulumi.Output<number>;
/**
* 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.
*/
readonly triggers: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Number of seconds since epoch time, e.g. `1581489373`.
*/
readonly unix: pulumi.Output<number>;
/**
* Number year of offset timestamp.
*/
readonly year: pulumi.Output<number>;
/**
* Create a Offset resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: OffsetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Offset resources.
*/
export interface OffsetState {
/**
* 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.
*/
baseRfc3339?: pulumi.Input<string>;
/**
* Number day of offset timestamp.
*/
day?: pulumi.Input<number>;
/**
* Number hour of offset timestamp.
*/
hour?: pulumi.Input<number>;
/**
* Number minute of offset timestamp.
*/
minute?: pulumi.Input<number>;
/**
* Number month of offset timestamp.
*/
month?: pulumi.Input<number>;
/**
* Number of days to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetDays?: pulumi.Input<number>;
/**
* Number of hours to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetHours?: pulumi.Input<number>;
/**
* Number of minutes to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetMinutes?: pulumi.Input<number>;
/**
* Number of months to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetMonths?: pulumi.Input<number>;
/**
* Number of seconds to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetSeconds?: pulumi.Input<number>;
/**
* Number of years to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetYears?: pulumi.Input<number>;
/**
* RFC3339 format of the offset timestamp, e.g. `2020-02-12T06:36:13Z`.
*/
rfc3339?: pulumi.Input<string>;
/**
* Number second of offset timestamp.
*/
second?: pulumi.Input<number>;
/**
* 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.
*/
triggers?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Number of seconds since epoch time, e.g. `1581489373`.
*/
unix?: pulumi.Input<number>;
/**
* Number year of offset timestamp.
*/
year?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Offset resource.
*/
export interface OffsetArgs {
/**
* 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.
*/
baseRfc3339?: pulumi.Input<string>;
/**
* Number of days to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetDays?: pulumi.Input<number>;
/**
* Number of hours to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetHours?: pulumi.Input<number>;
/**
* Number of minutes to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetMinutes?: pulumi.Input<number>;
/**
* Number of months to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetMonths?: pulumi.Input<number>;
/**
* Number of seconds to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetSeconds?: pulumi.Input<number>;
/**
* Number of years to offset the base timestamp. At least one of the 'offset_' arguments must be configured.
*/
offsetYears?: pulumi.Input<number>;
/**
* 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.
*/
triggers?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}