@cdktf/provider-azuread
Version:
Prebuilt azuread Provider for Terraform CDK (cdktf)
178 lines (177 loc) • 8.93 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface SynchronizationJobConfig extends cdktf.TerraformMetaArguments {
/**
* Whether or not the synchronization job is enabled
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#enabled SynchronizationJob#enabled}
*/
readonly enabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#id SynchronizationJob#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.
*/
readonly id?: string;
/**
* The ID of the service principal for which this synchronization job should be created
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#service_principal_id SynchronizationJob#service_principal_id}
*/
readonly servicePrincipalId: string;
/**
* Identifier of the synchronization template this job is based on.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#template_id SynchronizationJob#template_id}
*/
readonly templateId: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#timeouts SynchronizationJob#timeouts}
*/
readonly timeouts?: SynchronizationJobTimeouts;
}
export interface SynchronizationJobSchedule {
}
export declare function synchronizationJobScheduleToTerraform(struct?: SynchronizationJobSchedule): any;
export declare function synchronizationJobScheduleToHclTerraform(struct?: SynchronizationJobSchedule): any;
export declare class SynchronizationJobScheduleOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param complexObjectIndex the index of this item in the list
* @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
get internalValue(): SynchronizationJobSchedule | undefined;
set internalValue(value: SynchronizationJobSchedule | undefined);
get expiration(): string;
get interval(): string;
get state(): string;
}
export declare class SynchronizationJobScheduleList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
/**
* @param index the index of the item to return
*/
get(index: number): SynchronizationJobScheduleOutputReference;
}
export interface SynchronizationJobTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#create SynchronizationJob#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#delete SynchronizationJob#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#read SynchronizationJob#read}
*/
readonly read?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#update SynchronizationJob#update}
*/
readonly update?: string;
}
export declare function synchronizationJobTimeoutsToTerraform(struct?: SynchronizationJobTimeouts | cdktf.IResolvable): any;
export declare function synchronizationJobTimeoutsToHclTerraform(struct?: SynchronizationJobTimeouts | cdktf.IResolvable): any;
export declare class SynchronizationJobTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): SynchronizationJobTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: SynchronizationJobTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _read?;
get read(): string;
set read(value: string);
resetRead(): void;
get readInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job azuread_synchronization_job}
*/
export declare class SynchronizationJob extends cdktf.TerraformResource {
static readonly tfResourceType = "azuread_synchronization_job";
/**
* Generates CDKTF code for importing a SynchronizationJob resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the SynchronizationJob to import
* @param importFromId The id of the existing SynchronizationJob that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the SynchronizationJob to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/azuread/3.3.0/docs/resources/synchronization_job azuread_synchronization_job} Resource
*
* @param scope The scope in which to define this construct
* @param id The scoped construct ID. Must be unique amongst siblings in the same scope
* @param options SynchronizationJobConfig
*/
constructor(scope: Construct, id: string, config: SynchronizationJobConfig);
private _enabled?;
get enabled(): boolean | cdktf.IResolvable;
set enabled(value: boolean | cdktf.IResolvable);
resetEnabled(): void;
get enabledInput(): boolean | cdktf.IResolvable | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _schedule;
get schedule(): SynchronizationJobScheduleList;
private _servicePrincipalId?;
get servicePrincipalId(): string;
set servicePrincipalId(value: string);
get servicePrincipalIdInput(): string | undefined;
private _templateId?;
get templateId(): string;
set templateId(value: string);
get templateIdInput(): string | undefined;
private _timeouts;
get timeouts(): SynchronizationJobTimeoutsOutputReference;
putTimeouts(value: SynchronizationJobTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | SynchronizationJobTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}