1. Packages
  2. Rootly
  3. API Docs
  4. OverrideShift
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly

rootly.OverrideShift

Explore with Pulumi AI

Create OverrideShift Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new OverrideShift(name: string, args: OverrideShiftArgs, opts?: CustomResourceOptions);
@overload
def OverrideShift(resource_name: str,
                  args: OverrideShiftArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def OverrideShift(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  ends_at: Optional[str] = None,
                  starts_at: Optional[str] = None,
                  user_id: Optional[int] = None,
                  is_override: Optional[bool] = None,
                  rotation_id: Optional[str] = None,
                  schedule_id: Optional[str] = None,
                  shift_override: Optional[Mapping[str, str]] = None)
func NewOverrideShift(ctx *Context, name string, args OverrideShiftArgs, opts ...ResourceOption) (*OverrideShift, error)
public OverrideShift(string name, OverrideShiftArgs args, CustomResourceOptions? opts = null)
public OverrideShift(String name, OverrideShiftArgs args)
public OverrideShift(String name, OverrideShiftArgs args, CustomResourceOptions options)
type: rootly:OverrideShift
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OverrideShiftArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OverrideShiftArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OverrideShiftArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OverrideShiftArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OverrideShiftArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var overrideShiftResource = new Rootly.OverrideShift("overrideShiftResource", new()
{
    EndsAt = "string",
    StartsAt = "string",
    UserId = 0,
    IsOverride = false,
    RotationId = "string",
    ScheduleId = "string",
    ShiftOverride = 
    {
        { "string", "string" },
    },
});
Copy
example, err := rootly.NewOverrideShift(ctx, "overrideShiftResource", &rootly.OverrideShiftArgs{
	EndsAt:     pulumi.String("string"),
	StartsAt:   pulumi.String("string"),
	UserId:     pulumi.Int(0),
	IsOverride: pulumi.Bool(false),
	RotationId: pulumi.String("string"),
	ScheduleId: pulumi.String("string"),
	ShiftOverride: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var overrideShiftResource = new OverrideShift("overrideShiftResource", OverrideShiftArgs.builder()
    .endsAt("string")
    .startsAt("string")
    .userId(0)
    .isOverride(false)
    .rotationId("string")
    .scheduleId("string")
    .shiftOverride(Map.of("string", "string"))
    .build());
Copy
override_shift_resource = rootly.OverrideShift("overrideShiftResource",
    ends_at="string",
    starts_at="string",
    user_id=0,
    is_override=False,
    rotation_id="string",
    schedule_id="string",
    shift_override={
        "string": "string",
    })
Copy
const overrideShiftResource = new rootly.OverrideShift("overrideShiftResource", {
    endsAt: "string",
    startsAt: "string",
    userId: 0,
    isOverride: false,
    rotationId: "string",
    scheduleId: "string",
    shiftOverride: {
        string: "string",
    },
});
Copy
type: rootly:OverrideShift
properties:
    endsAt: string
    isOverride: false
    rotationId: string
    scheduleId: string
    shiftOverride:
        string: string
    startsAt: string
    userId: 0
Copy

OverrideShift Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The OverrideShift resource accepts the following input properties:

EndsAt This property is required. string
End datetime of shift
StartsAt This property is required. string
Start datetime of shift
UserId This property is required. int
User to whom override shift is assigned to
IsOverride bool
Denotes shift is an override shift. Value must be one of true or false
RotationId string
ID of rotation
ScheduleId Changes to this property will trigger replacement. string
ID of schedule
ShiftOverride Dictionary<string, string>
Override metadata
EndsAt This property is required. string
End datetime of shift
StartsAt This property is required. string
Start datetime of shift
UserId This property is required. int
User to whom override shift is assigned to
IsOverride bool
Denotes shift is an override shift. Value must be one of true or false
RotationId string
ID of rotation
ScheduleId Changes to this property will trigger replacement. string
ID of schedule
ShiftOverride map[string]string
Override metadata
endsAt This property is required. String
End datetime of shift
startsAt This property is required. String
Start datetime of shift
userId This property is required. Integer
User to whom override shift is assigned to
isOverride Boolean
Denotes shift is an override shift. Value must be one of true or false
rotationId String
ID of rotation
scheduleId Changes to this property will trigger replacement. String
ID of schedule
shiftOverride Map<String,String>
Override metadata
endsAt This property is required. string
End datetime of shift
startsAt This property is required. string
Start datetime of shift
userId This property is required. number
User to whom override shift is assigned to
isOverride boolean
Denotes shift is an override shift. Value must be one of true or false
rotationId string
ID of rotation
scheduleId Changes to this property will trigger replacement. string
ID of schedule
shiftOverride {[key: string]: string}
Override metadata
ends_at This property is required. str
End datetime of shift
starts_at This property is required. str
Start datetime of shift
user_id This property is required. int
User to whom override shift is assigned to
is_override bool
Denotes shift is an override shift. Value must be one of true or false
rotation_id str
ID of rotation
schedule_id Changes to this property will trigger replacement. str
ID of schedule
shift_override Mapping[str, str]
Override metadata
endsAt This property is required. String
End datetime of shift
startsAt This property is required. String
Start datetime of shift
userId This property is required. Number
User to whom override shift is assigned to
isOverride Boolean
Denotes shift is an override shift. Value must be one of true or false
rotationId String
ID of rotation
scheduleId Changes to this property will trigger replacement. String
ID of schedule
shiftOverride Map<String>
Override metadata

Outputs

All input properties are implicitly available as output properties. Additionally, the OverrideShift resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing OverrideShift Resource

Get an existing OverrideShift resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OverrideShiftState, opts?: CustomResourceOptions): OverrideShift
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ends_at: Optional[str] = None,
        is_override: Optional[bool] = None,
        rotation_id: Optional[str] = None,
        schedule_id: Optional[str] = None,
        shift_override: Optional[Mapping[str, str]] = None,
        starts_at: Optional[str] = None,
        user_id: Optional[int] = None) -> OverrideShift
func GetOverrideShift(ctx *Context, name string, id IDInput, state *OverrideShiftState, opts ...ResourceOption) (*OverrideShift, error)
public static OverrideShift Get(string name, Input<string> id, OverrideShiftState? state, CustomResourceOptions? opts = null)
public static OverrideShift get(String name, Output<String> id, OverrideShiftState state, CustomResourceOptions options)
resources:  _:    type: rootly:OverrideShift    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
EndsAt string
End datetime of shift
IsOverride bool
Denotes shift is an override shift. Value must be one of true or false
RotationId string
ID of rotation
ScheduleId Changes to this property will trigger replacement. string
ID of schedule
ShiftOverride Dictionary<string, string>
Override metadata
StartsAt string
Start datetime of shift
UserId int
User to whom override shift is assigned to
EndsAt string
End datetime of shift
IsOverride bool
Denotes shift is an override shift. Value must be one of true or false
RotationId string
ID of rotation
ScheduleId Changes to this property will trigger replacement. string
ID of schedule
ShiftOverride map[string]string
Override metadata
StartsAt string
Start datetime of shift
UserId int
User to whom override shift is assigned to
endsAt String
End datetime of shift
isOverride Boolean
Denotes shift is an override shift. Value must be one of true or false
rotationId String
ID of rotation
scheduleId Changes to this property will trigger replacement. String
ID of schedule
shiftOverride Map<String,String>
Override metadata
startsAt String
Start datetime of shift
userId Integer
User to whom override shift is assigned to
endsAt string
End datetime of shift
isOverride boolean
Denotes shift is an override shift. Value must be one of true or false
rotationId string
ID of rotation
scheduleId Changes to this property will trigger replacement. string
ID of schedule
shiftOverride {[key: string]: string}
Override metadata
startsAt string
Start datetime of shift
userId number
User to whom override shift is assigned to
ends_at str
End datetime of shift
is_override bool
Denotes shift is an override shift. Value must be one of true or false
rotation_id str
ID of rotation
schedule_id Changes to this property will trigger replacement. str
ID of schedule
shift_override Mapping[str, str]
Override metadata
starts_at str
Start datetime of shift
user_id int
User to whom override shift is assigned to
endsAt String
End datetime of shift
isOverride Boolean
Denotes shift is an override shift. Value must be one of true or false
rotationId String
ID of rotation
scheduleId Changes to this property will trigger replacement. String
ID of schedule
shiftOverride Map<String>
Override metadata
startsAt String
Start datetime of shift
userId Number
User to whom override shift is assigned to

Package Details

Repository
rootly rootlyhq/pulumi-rootly
License
Apache-2.0
Notes
This Pulumi package is based on the rootly Terraform Provider.