@lbrlabs/pulumi-cockroach
Version:
A Pulumi package to create and managed cockroach db resources in Pulumi programs.
102 lines (101 loc) • 3.92 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Configuration to allow external OIDC providers to issue tokens for use with CC API.
*/
export declare class ApiOidcConfig extends pulumi.CustomResource {
/**
* Get an existing ApiOidcConfig 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<pulumi.ID>, state?: ApiOidcConfigState, opts?: pulumi.CustomResourceOptions): ApiOidcConfig;
/**
* Returns true if the given object is an instance of ApiOidcConfig. 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 ApiOidcConfig;
/**
* The audience that CC API should accept for this API OIDC Configuration.
*/
readonly audience: pulumi.Output<string>;
/**
* The JWT claim that should be used as the user identifier. Defaults to the subject.
*/
readonly claim: pulumi.Output<string>;
/**
* The mapping rules to convert token user identifiers into a new form.
*/
readonly identityMaps: pulumi.Output<outputs.ApiOidcConfigIdentityMap[]>;
/**
* The issuer of tokens for the API OIDC Configuration. Usually this is a url.
*/
readonly issuer: pulumi.Output<string>;
/**
* The JSON Web Key Set used to check the signature of the JWTs.
*/
readonly jwks: pulumi.Output<string>;
/**
* Create a ApiOidcConfig 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: ApiOidcConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApiOidcConfig resources.
*/
export interface ApiOidcConfigState {
/**
* The audience that CC API should accept for this API OIDC Configuration.
*/
audience?: pulumi.Input<string>;
/**
* The JWT claim that should be used as the user identifier. Defaults to the subject.
*/
claim?: pulumi.Input<string>;
/**
* The mapping rules to convert token user identifiers into a new form.
*/
identityMaps?: pulumi.Input<pulumi.Input<inputs.ApiOidcConfigIdentityMap>[]>;
/**
* The issuer of tokens for the API OIDC Configuration. Usually this is a url.
*/
issuer?: pulumi.Input<string>;
/**
* The JSON Web Key Set used to check the signature of the JWTs.
*/
jwks?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ApiOidcConfig resource.
*/
export interface ApiOidcConfigArgs {
/**
* The audience that CC API should accept for this API OIDC Configuration.
*/
audience: pulumi.Input<string>;
/**
* The JWT claim that should be used as the user identifier. Defaults to the subject.
*/
claim?: pulumi.Input<string>;
/**
* The mapping rules to convert token user identifiers into a new form.
*/
identityMaps?: pulumi.Input<pulumi.Input<inputs.ApiOidcConfigIdentityMap>[]>;
/**
* The issuer of tokens for the API OIDC Configuration. Usually this is a url.
*/
issuer: pulumi.Input<string>;
/**
* The JSON Web Key Set used to check the signature of the JWTs.
*/
jwks: pulumi.Input<string>;
}