@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
229 lines (228 loc) • 12.5 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface IdentityPlatformTenantConfig extends cdktf.TerraformMetaArguments {
/**
* Whether to allow email/password user authentication.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#allow_password_signup IdentityPlatformTenant#allow_password_signup}
*/
readonly allowPasswordSignup?: boolean | cdktf.IResolvable;
/**
* Whether authentication is disabled for the tenant. If true, the users under
* the disabled tenant are not allowed to sign-in. Admins of the disabled tenant
* are not able to manage its users.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#disable_auth IdentityPlatformTenant#disable_auth}
*/
readonly disableAuth?: boolean | cdktf.IResolvable;
/**
* Human friendly display name of the tenant.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#display_name IdentityPlatformTenant#display_name}
*/
readonly displayName: string;
/**
* Whether to enable email link user authentication.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#enable_email_link_signin IdentityPlatformTenant#enable_email_link_signin}
*/
readonly enableEmailLinkSignin?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#id IdentityPlatformTenant#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;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#project IdentityPlatformTenant#project}
*/
readonly project?: string;
/**
* client block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#client IdentityPlatformTenant#client}
*/
readonly client?: IdentityPlatformTenantClient;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#timeouts IdentityPlatformTenant#timeouts}
*/
readonly timeouts?: IdentityPlatformTenantTimeouts;
}
export interface IdentityPlatformTenantClientPermissions {
/**
* When true, end users cannot delete their account on the associated project through any of our API methods.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#disabled_user_deletion IdentityPlatformTenant#disabled_user_deletion}
*/
readonly disabledUserDeletion?: boolean | cdktf.IResolvable;
/**
* When true, end users cannot sign up for a new account on the associated project through any of our API methods.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#disabled_user_signup IdentityPlatformTenant#disabled_user_signup}
*/
readonly disabledUserSignup?: boolean | cdktf.IResolvable;
}
export declare function identityPlatformTenantClientPermissionsToTerraform(struct?: IdentityPlatformTenantClientPermissionsOutputReference | IdentityPlatformTenantClientPermissions): any;
export declare function identityPlatformTenantClientPermissionsToHclTerraform(struct?: IdentityPlatformTenantClientPermissionsOutputReference | IdentityPlatformTenantClientPermissions): any;
export declare class IdentityPlatformTenantClientPermissionsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @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(): IdentityPlatformTenantClientPermissions | undefined;
set internalValue(value: IdentityPlatformTenantClientPermissions | undefined);
private _disabledUserDeletion?;
get disabledUserDeletion(): boolean | cdktf.IResolvable;
set disabledUserDeletion(value: boolean | cdktf.IResolvable);
resetDisabledUserDeletion(): void;
get disabledUserDeletionInput(): boolean | cdktf.IResolvable | undefined;
private _disabledUserSignup?;
get disabledUserSignup(): boolean | cdktf.IResolvable;
set disabledUserSignup(value: boolean | cdktf.IResolvable);
resetDisabledUserSignup(): void;
get disabledUserSignupInput(): boolean | cdktf.IResolvable | undefined;
}
export interface IdentityPlatformTenantClient {
/**
* permissions block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#permissions IdentityPlatformTenant#permissions}
*/
readonly permissions?: IdentityPlatformTenantClientPermissions;
}
export declare function identityPlatformTenantClientToTerraform(struct?: IdentityPlatformTenantClientOutputReference | IdentityPlatformTenantClient): any;
export declare function identityPlatformTenantClientToHclTerraform(struct?: IdentityPlatformTenantClientOutputReference | IdentityPlatformTenantClient): any;
export declare class IdentityPlatformTenantClientOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @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(): IdentityPlatformTenantClient | undefined;
set internalValue(value: IdentityPlatformTenantClient | undefined);
private _permissions;
get permissions(): IdentityPlatformTenantClientPermissionsOutputReference;
putPermissions(value: IdentityPlatformTenantClientPermissions): void;
resetPermissions(): void;
get permissionsInput(): IdentityPlatformTenantClientPermissions | undefined;
}
export interface IdentityPlatformTenantTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#create IdentityPlatformTenant#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#delete IdentityPlatformTenant#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#update IdentityPlatformTenant#update}
*/
readonly update?: string;
}
export declare function identityPlatformTenantTimeoutsToTerraform(struct?: IdentityPlatformTenantTimeouts | cdktf.IResolvable): any;
export declare function identityPlatformTenantTimeoutsToHclTerraform(struct?: IdentityPlatformTenantTimeouts | cdktf.IResolvable): any;
export declare class IdentityPlatformTenantTimeoutsOutputReference 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(): IdentityPlatformTenantTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: IdentityPlatformTenantTimeouts | 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 _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant google_identity_platform_tenant}
*/
export declare class IdentityPlatformTenant extends cdktf.TerraformResource {
static readonly tfResourceType = "google_identity_platform_tenant";
/**
* Generates CDKTF code for importing a IdentityPlatformTenant 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 IdentityPlatformTenant to import
* @param importFromId The id of the existing IdentityPlatformTenant that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/identity_platform_tenant#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the IdentityPlatformTenant 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/google/6.36.0/docs/resources/identity_platform_tenant google_identity_platform_tenant} 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 IdentityPlatformTenantConfig
*/
constructor(scope: Construct, id: string, config: IdentityPlatformTenantConfig);
private _allowPasswordSignup?;
get allowPasswordSignup(): boolean | cdktf.IResolvable;
set allowPasswordSignup(value: boolean | cdktf.IResolvable);
resetAllowPasswordSignup(): void;
get allowPasswordSignupInput(): boolean | cdktf.IResolvable | undefined;
private _disableAuth?;
get disableAuth(): boolean | cdktf.IResolvable;
set disableAuth(value: boolean | cdktf.IResolvable);
resetDisableAuth(): void;
get disableAuthInput(): boolean | cdktf.IResolvable | undefined;
private _displayName?;
get displayName(): string;
set displayName(value: string);
get displayNameInput(): string | undefined;
private _enableEmailLinkSignin?;
get enableEmailLinkSignin(): boolean | cdktf.IResolvable;
set enableEmailLinkSignin(value: boolean | cdktf.IResolvable);
resetEnableEmailLinkSignin(): void;
get enableEmailLinkSigninInput(): boolean | cdktf.IResolvable | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
get name(): string;
private _project?;
get project(): string;
set project(value: string);
resetProject(): void;
get projectInput(): string | undefined;
private _client;
get client(): IdentityPlatformTenantClientOutputReference;
putClient(value: IdentityPlatformTenantClient): void;
resetClient(): void;
get clientInput(): IdentityPlatformTenantClient | undefined;
private _timeouts;
get timeouts(): IdentityPlatformTenantTimeoutsOutputReference;
putTimeouts(value: IdentityPlatformTenantTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | IdentityPlatformTenantTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}