import * as pulumi from "@pulumi/pulumi"; /** * Represents an OAuth Client Credential. Used to authenticate an OAuth Client * while accessing Google Cloud resources on behalf of a Workforce Identity Federation user * by using OAuth 2.0 Protocol. * * To get more information about OauthClientCredential, see: * * * [API documentation](https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.oauthClients.credentials) * * How-to Guides * * [Managing OAuth clients](https://cloud.google.com/iam/docs/workforce-manage-oauth-app#manage-clients) * * ## Example Usage * * ### Iam Oauth Client Credential Full * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const oauthClient = new gcp.iam.OauthClient("oauth_client", { * oauthClientId: "example-client-id", * location: "global", * allowedGrantTypes: ["AUTHORIZATION_CODE_GRANT"], * allowedRedirectUris: ["https://www.example.com"], * allowedScopes: ["https://www.googleapis.com/auth/cloud-platform"], * clientType: "CONFIDENTIAL_CLIENT", * }); * const example = new gcp.iam.OauthClientCredential("example", { * oauthclient: oauthClient.oauthClientId, * location: oauthClient.location, * oauthClientCredentialId: "cred-id", * disabled: true, * displayName: "Display Name of credential", * }); * ``` * * ## Import * * OauthClientCredential can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/oauthClients/{{oauthclient}}/credentials/{{oauth_client_credential_id}}` * * `{{project}}/{{location}}/{{oauthclient}}/{{oauth_client_credential_id}}` * * `{{location}}/{{oauthclient}}/{{oauth_client_credential_id}}` * * When using the `pulumi import` command, OauthClientCredential can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:iam/oauthClientCredential:OauthClientCredential default projects/{{project}}/locations/{{location}}/oauthClients/{{oauthclient}}/credentials/{{oauth_client_credential_id}} * $ pulumi import gcp:iam/oauthClientCredential:OauthClientCredential default {{project}}/{{location}}/{{oauthclient}}/{{oauth_client_credential_id}} * $ pulumi import gcp:iam/oauthClientCredential:OauthClientCredential default {{location}}/{{oauthclient}}/{{oauth_client_credential_id}} * ``` */ export declare class OauthClientCredential extends pulumi.CustomResource { /** * Get an existing OauthClientCredential resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: OauthClientCredentialState, opts?: pulumi.CustomResourceOptions): OauthClientCredential; /** * Returns true if the given object is an instance of OauthClientCredential. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is OauthClientCredential; /** * The system-generated OAuth client secret. * The client secret must be stored securely. If the client secret is * leaked, you must delete and re-create the client credential. To learn * more, see [OAuth client and credential security risks and * mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security) * **Note**: This property is sensitive and will not be displayed in the plan. */ readonly clientSecret: pulumi.Output; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ readonly deletionPolicy: pulumi.Output; /** * Whether the OauthClientCredential is disabled. You cannot use a * disabled OauthClientCredential. */ readonly disabled: pulumi.Output; /** * A user-specified display name of the OauthClientCredential. * Cannot exceed 32 characters. */ readonly displayName: pulumi.Output; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ readonly location: pulumi.Output; /** * Immutable. Identifier. The resource name of the OauthClientCredential. * Format: * `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` */ readonly name: pulumi.Output; /** * Required. The ID to use for the OauthClientCredential, which becomes the * final component of the resource name. This value should be 4-32 characters, * and may contain the characters [a-z0-9-]. The prefix `gcp-` is * reserved for use by Google, and may not be specified. */ readonly oauthClientCredentialId: pulumi.Output; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ readonly oauthclient: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * Create a OauthClientCredential resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: OauthClientCredentialArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering OauthClientCredential resources. */ export interface OauthClientCredentialState { /** * The system-generated OAuth client secret. * The client secret must be stored securely. If the client secret is * leaked, you must delete and re-create the client credential. To learn * more, see [OAuth client and credential security risks and * mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security) * **Note**: This property is sensitive and will not be displayed in the plan. */ clientSecret?: pulumi.Input; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * Whether the OauthClientCredential is disabled. You cannot use a * disabled OauthClientCredential. */ disabled?: pulumi.Input; /** * A user-specified display name of the OauthClientCredential. * Cannot exceed 32 characters. */ displayName?: pulumi.Input; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ location?: pulumi.Input; /** * Immutable. Identifier. The resource name of the OauthClientCredential. * Format: * `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` */ name?: pulumi.Input; /** * Required. The ID to use for the OauthClientCredential, which becomes the * final component of the resource name. This value should be 4-32 characters, * and may contain the characters [a-z0-9-]. The prefix `gcp-` is * reserved for use by Google, and may not be specified. */ oauthClientCredentialId?: pulumi.Input; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ oauthclient?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; } /** * The set of arguments for constructing a OauthClientCredential resource. */ export interface OauthClientCredentialArgs { /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * Whether the OauthClientCredential is disabled. You cannot use a * disabled OauthClientCredential. */ disabled?: pulumi.Input; /** * A user-specified display name of the OauthClientCredential. * Cannot exceed 32 characters. */ displayName?: pulumi.Input; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ location: pulumi.Input; /** * Required. The ID to use for the OauthClientCredential, which becomes the * final component of the resource name. This value should be 4-32 characters, * and may contain the characters [a-z0-9-]. The prefix `gcp-` is * reserved for use by Google, and may not be specified. */ oauthClientCredentialId: pulumi.Input; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ oauthclient: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; } //# sourceMappingURL=oauthClientCredential.d.ts.map