@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
221 lines (220 loc) • 11.6 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface IdentityPlatformOauthIdpConfigConfig extends cdktf.TerraformMetaArguments {
/**
* The client id of an OAuth client.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#client_id IdentityPlatformOauthIdpConfig#client_id}
*/
readonly clientId: string;
/**
* The client secret of the OAuth client, to enable OIDC code flow.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#client_secret IdentityPlatformOauthIdpConfig#client_secret}
*/
readonly clientSecret?: string;
/**
* Human friendly display name.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#display_name IdentityPlatformOauthIdpConfig#display_name}
*/
readonly displayName?: string;
/**
* If this config allows users to sign in with the provider.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#enabled IdentityPlatformOauthIdpConfig#enabled}
*/
readonly enabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#id IdentityPlatformOauthIdpConfig#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;
/**
* For OIDC Idps, the issuer identifier.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#issuer IdentityPlatformOauthIdpConfig#issuer}
*/
readonly issuer: string;
/**
* The name of the OauthIdpConfig. Must start with 'oidc.'.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#name IdentityPlatformOauthIdpConfig#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#project IdentityPlatformOauthIdpConfig#project}
*/
readonly project?: string;
/**
* response_type block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#response_type IdentityPlatformOauthIdpConfig#response_type}
*/
readonly responseType?: IdentityPlatformOauthIdpConfigResponseType;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#timeouts IdentityPlatformOauthIdpConfig#timeouts}
*/
readonly timeouts?: IdentityPlatformOauthIdpConfigTimeouts;
}
export interface IdentityPlatformOauthIdpConfigResponseType {
/**
* If true, authorization code is returned from IdP's authorization endpoint.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#code IdentityPlatformOauthIdpConfig#code}
*/
readonly code?: boolean | cdktf.IResolvable;
/**
* If true, ID token is returned from IdP's authorization endpoint.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#id_token IdentityPlatformOauthIdpConfig#id_token}
*/
readonly idToken?: boolean | cdktf.IResolvable;
}
export declare function identityPlatformOauthIdpConfigResponseTypeToTerraform(struct?: IdentityPlatformOauthIdpConfigResponseTypeOutputReference | IdentityPlatformOauthIdpConfigResponseType): any;
export declare function identityPlatformOauthIdpConfigResponseTypeToHclTerraform(struct?: IdentityPlatformOauthIdpConfigResponseTypeOutputReference | IdentityPlatformOauthIdpConfigResponseType): any;
export declare class IdentityPlatformOauthIdpConfigResponseTypeOutputReference 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(): IdentityPlatformOauthIdpConfigResponseType | undefined;
set internalValue(value: IdentityPlatformOauthIdpConfigResponseType | undefined);
private _code?;
get code(): boolean | cdktf.IResolvable;
set code(value: boolean | cdktf.IResolvable);
resetCode(): void;
get codeInput(): boolean | cdktf.IResolvable | undefined;
private _idToken?;
get idToken(): boolean | cdktf.IResolvable;
set idToken(value: boolean | cdktf.IResolvable);
resetIdToken(): void;
get idTokenInput(): boolean | cdktf.IResolvable | undefined;
}
export interface IdentityPlatformOauthIdpConfigTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#create IdentityPlatformOauthIdpConfig#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#delete IdentityPlatformOauthIdpConfig#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#update IdentityPlatformOauthIdpConfig#update}
*/
readonly update?: string;
}
export declare function identityPlatformOauthIdpConfigTimeoutsToTerraform(struct?: IdentityPlatformOauthIdpConfigTimeouts | cdktf.IResolvable): any;
export declare function identityPlatformOauthIdpConfigTimeoutsToHclTerraform(struct?: IdentityPlatformOauthIdpConfigTimeouts | cdktf.IResolvable): any;
export declare class IdentityPlatformOauthIdpConfigTimeoutsOutputReference 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(): IdentityPlatformOauthIdpConfigTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: IdentityPlatformOauthIdpConfigTimeouts | 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.1/docs/resources/identity_platform_oauth_idp_config google_identity_platform_oauth_idp_config}
*/
export declare class IdentityPlatformOauthIdpConfig extends cdktf.TerraformResource {
static readonly tfResourceType = "google_identity_platform_oauth_idp_config";
/**
* Generates CDKTF code for importing a IdentityPlatformOauthIdpConfig 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 IdentityPlatformOauthIdpConfig to import
* @param importFromId The id of the existing IdentityPlatformOauthIdpConfig that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_oauth_idp_config#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the IdentityPlatformOauthIdpConfig 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.1/docs/resources/identity_platform_oauth_idp_config google_identity_platform_oauth_idp_config} 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 IdentityPlatformOauthIdpConfigConfig
*/
constructor(scope: Construct, id: string, config: IdentityPlatformOauthIdpConfigConfig);
private _clientId?;
get clientId(): string;
set clientId(value: string);
get clientIdInput(): string | undefined;
private _clientSecret?;
get clientSecret(): string;
set clientSecret(value: string);
resetClientSecret(): void;
get clientSecretInput(): string | undefined;
private _displayName?;
get displayName(): string;
set displayName(value: string);
resetDisplayName(): void;
get displayNameInput(): string | undefined;
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 _issuer?;
get issuer(): string;
set issuer(value: string);
get issuerInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _project?;
get project(): string;
set project(value: string);
resetProject(): void;
get projectInput(): string | undefined;
private _responseType;
get responseType(): IdentityPlatformOauthIdpConfigResponseTypeOutputReference;
putResponseType(value: IdentityPlatformOauthIdpConfigResponseType): void;
resetResponseType(): void;
get responseTypeInput(): IdentityPlatformOauthIdpConfigResponseType | undefined;
private _timeouts;
get timeouts(): IdentityPlatformOauthIdpConfigTimeoutsOutputReference;
putTimeouts(value: IdentityPlatformOauthIdpConfigTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | IdentityPlatformOauthIdpConfigTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}