@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
333 lines (332 loc) • 19.3 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface IdentityPlatformInboundSamlConfigConfig extends cdktf.TerraformMetaArguments {
/**
* Human friendly display name.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#display_name IdentityPlatformInboundSamlConfig#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_inbound_saml_config#enabled IdentityPlatformInboundSamlConfig#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_inbound_saml_config#id IdentityPlatformInboundSamlConfig#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 name of the InboundSamlConfig resource. Must start with 'saml.' and can only have alphanumeric characters,
* hyphens, underscores or periods. The part after 'saml.' must also start with a lowercase letter, end with an
* alphanumeric character, and have at least 2 characters.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#name IdentityPlatformInboundSamlConfig#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#project IdentityPlatformInboundSamlConfig#project}
*/
readonly project?: string;
/**
* idp_config block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#idp_config IdentityPlatformInboundSamlConfig#idp_config}
*/
readonly idpConfig: IdentityPlatformInboundSamlConfigIdpConfig;
/**
* sp_config block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#sp_config IdentityPlatformInboundSamlConfig#sp_config}
*/
readonly spConfig: IdentityPlatformInboundSamlConfigSpConfig;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#timeouts IdentityPlatformInboundSamlConfig#timeouts}
*/
readonly timeouts?: IdentityPlatformInboundSamlConfigTimeouts;
}
export interface IdentityPlatformInboundSamlConfigIdpConfigIdpCertificates {
/**
* The IdP's x509 certificate.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#x509_certificate IdentityPlatformInboundSamlConfig#x509_certificate}
*/
readonly x509Certificate?: string;
}
export declare function identityPlatformInboundSamlConfigIdpConfigIdpCertificatesToTerraform(struct?: IdentityPlatformInboundSamlConfigIdpConfigIdpCertificates | cdktf.IResolvable): any;
export declare function identityPlatformInboundSamlConfigIdpConfigIdpCertificatesToHclTerraform(struct?: IdentityPlatformInboundSamlConfigIdpConfigIdpCertificates | cdktf.IResolvable): any;
export declare class IdentityPlatformInboundSamlConfigIdpConfigIdpCertificatesOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @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(): IdentityPlatformInboundSamlConfigIdpConfigIdpCertificates | cdktf.IResolvable | undefined;
set internalValue(value: IdentityPlatformInboundSamlConfigIdpConfigIdpCertificates | cdktf.IResolvable | undefined);
private _x509Certificate?;
get x509Certificate(): string;
set x509Certificate(value: string);
resetX509Certificate(): void;
get x509CertificateInput(): string | undefined;
}
export declare class IdentityPlatformInboundSamlConfigIdpConfigIdpCertificatesList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: IdentityPlatformInboundSamlConfigIdpConfigIdpCertificates[] | cdktf.IResolvable;
/**
* @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): IdentityPlatformInboundSamlConfigIdpConfigIdpCertificatesOutputReference;
}
export interface IdentityPlatformInboundSamlConfigIdpConfig {
/**
* Unique identifier for all SAML entities
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#idp_entity_id IdentityPlatformInboundSamlConfig#idp_entity_id}
*/
readonly idpEntityId: string;
/**
* Indicates if outbounding SAMLRequest should be signed.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#sign_request IdentityPlatformInboundSamlConfig#sign_request}
*/
readonly signRequest?: boolean | cdktf.IResolvable;
/**
* URL to send Authentication request to.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#sso_url IdentityPlatformInboundSamlConfig#sso_url}
*/
readonly ssoUrl: string;
/**
* idp_certificates block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#idp_certificates IdentityPlatformInboundSamlConfig#idp_certificates}
*/
readonly idpCertificates: IdentityPlatformInboundSamlConfigIdpConfigIdpCertificates[] | cdktf.IResolvable;
}
export declare function identityPlatformInboundSamlConfigIdpConfigToTerraform(struct?: IdentityPlatformInboundSamlConfigIdpConfigOutputReference | IdentityPlatformInboundSamlConfigIdpConfig): any;
export declare function identityPlatformInboundSamlConfigIdpConfigToHclTerraform(struct?: IdentityPlatformInboundSamlConfigIdpConfigOutputReference | IdentityPlatformInboundSamlConfigIdpConfig): any;
export declare class IdentityPlatformInboundSamlConfigIdpConfigOutputReference 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(): IdentityPlatformInboundSamlConfigIdpConfig | undefined;
set internalValue(value: IdentityPlatformInboundSamlConfigIdpConfig | undefined);
private _idpEntityId?;
get idpEntityId(): string;
set idpEntityId(value: string);
get idpEntityIdInput(): string | undefined;
private _signRequest?;
get signRequest(): boolean | cdktf.IResolvable;
set signRequest(value: boolean | cdktf.IResolvable);
resetSignRequest(): void;
get signRequestInput(): boolean | cdktf.IResolvable | undefined;
private _ssoUrl?;
get ssoUrl(): string;
set ssoUrl(value: string);
get ssoUrlInput(): string | undefined;
private _idpCertificates;
get idpCertificates(): IdentityPlatformInboundSamlConfigIdpConfigIdpCertificatesList;
putIdpCertificates(value: IdentityPlatformInboundSamlConfigIdpConfigIdpCertificates[] | cdktf.IResolvable): void;
get idpCertificatesInput(): cdktf.IResolvable | IdentityPlatformInboundSamlConfigIdpConfigIdpCertificates[] | undefined;
}
export interface IdentityPlatformInboundSamlConfigSpConfigSpCertificates {
}
export declare function identityPlatformInboundSamlConfigSpConfigSpCertificatesToTerraform(struct?: IdentityPlatformInboundSamlConfigSpConfigSpCertificates): any;
export declare function identityPlatformInboundSamlConfigSpConfigSpCertificatesToHclTerraform(struct?: IdentityPlatformInboundSamlConfigSpConfigSpCertificates): any;
export declare class IdentityPlatformInboundSamlConfigSpConfigSpCertificatesOutputReference 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(): IdentityPlatformInboundSamlConfigSpConfigSpCertificates | undefined;
set internalValue(value: IdentityPlatformInboundSamlConfigSpConfigSpCertificates | undefined);
get x509Certificate(): string;
}
export declare class IdentityPlatformInboundSamlConfigSpConfigSpCertificatesList 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): IdentityPlatformInboundSamlConfigSpConfigSpCertificatesOutputReference;
}
export interface IdentityPlatformInboundSamlConfigSpConfig {
/**
* Callback URI where responses from IDP are handled. Must start with 'https://'.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#callback_uri IdentityPlatformInboundSamlConfig#callback_uri}
*/
readonly callbackUri?: string;
/**
* Unique identifier for all SAML entities.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#sp_entity_id IdentityPlatformInboundSamlConfig#sp_entity_id}
*/
readonly spEntityId?: string;
}
export declare function identityPlatformInboundSamlConfigSpConfigToTerraform(struct?: IdentityPlatformInboundSamlConfigSpConfigOutputReference | IdentityPlatformInboundSamlConfigSpConfig): any;
export declare function identityPlatformInboundSamlConfigSpConfigToHclTerraform(struct?: IdentityPlatformInboundSamlConfigSpConfigOutputReference | IdentityPlatformInboundSamlConfigSpConfig): any;
export declare class IdentityPlatformInboundSamlConfigSpConfigOutputReference 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(): IdentityPlatformInboundSamlConfigSpConfig | undefined;
set internalValue(value: IdentityPlatformInboundSamlConfigSpConfig | undefined);
private _callbackUri?;
get callbackUri(): string;
set callbackUri(value: string);
resetCallbackUri(): void;
get callbackUriInput(): string | undefined;
private _spCertificates;
get spCertificates(): IdentityPlatformInboundSamlConfigSpConfigSpCertificatesList;
private _spEntityId?;
get spEntityId(): string;
set spEntityId(value: string);
resetSpEntityId(): void;
get spEntityIdInput(): string | undefined;
}
export interface IdentityPlatformInboundSamlConfigTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#create IdentityPlatformInboundSamlConfig#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#delete IdentityPlatformInboundSamlConfig#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#update IdentityPlatformInboundSamlConfig#update}
*/
readonly update?: string;
}
export declare function identityPlatformInboundSamlConfigTimeoutsToTerraform(struct?: IdentityPlatformInboundSamlConfigTimeouts | cdktf.IResolvable): any;
export declare function identityPlatformInboundSamlConfigTimeoutsToHclTerraform(struct?: IdentityPlatformInboundSamlConfigTimeouts | cdktf.IResolvable): any;
export declare class IdentityPlatformInboundSamlConfigTimeoutsOutputReference 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(): IdentityPlatformInboundSamlConfigTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: IdentityPlatformInboundSamlConfigTimeouts | 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_inbound_saml_config google_identity_platform_inbound_saml_config}
*/
export declare class IdentityPlatformInboundSamlConfig extends cdktf.TerraformResource {
static readonly tfResourceType = "google_identity_platform_inbound_saml_config";
/**
* Generates CDKTF code for importing a IdentityPlatformInboundSamlConfig 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 IdentityPlatformInboundSamlConfig to import
* @param importFromId The id of the existing IdentityPlatformInboundSamlConfig that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/identity_platform_inbound_saml_config#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the IdentityPlatformInboundSamlConfig 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_inbound_saml_config google_identity_platform_inbound_saml_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 IdentityPlatformInboundSamlConfigConfig
*/
constructor(scope: Construct, id: string, config: IdentityPlatformInboundSamlConfigConfig);
private _displayName?;
get displayName(): string;
set displayName(value: string);
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 _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 _idpConfig;
get idpConfig(): IdentityPlatformInboundSamlConfigIdpConfigOutputReference;
putIdpConfig(value: IdentityPlatformInboundSamlConfigIdpConfig): void;
get idpConfigInput(): IdentityPlatformInboundSamlConfigIdpConfig | undefined;
private _spConfig;
get spConfig(): IdentityPlatformInboundSamlConfigSpConfigOutputReference;
putSpConfig(value: IdentityPlatformInboundSamlConfigSpConfig): void;
get spConfigInput(): IdentityPlatformInboundSamlConfigSpConfig | undefined;
private _timeouts;
get timeouts(): IdentityPlatformInboundSamlConfigTimeoutsOutputReference;
putTimeouts(value: IdentityPlatformInboundSamlConfigTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | IdentityPlatformInboundSamlConfigTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}