@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
153 lines (152 loc) • 5.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Definition of AWS::WorkSpacesWeb::IdentityProvider Resource Type
*/
export declare class IdentityProvider extends pulumi.CustomResource {
/**
* Get an existing IdentityProvider 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): IdentityProvider;
/**
* Returns true if the given object is an instance of IdentityProvider. 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 IdentityProvider;
/**
* The ARN of the identity provider.
*/
readonly identityProviderArn: pulumi.Output<string>;
/**
* The identity provider details. The following list describes the provider detail keys for each identity provider type.
*
* - For Google and Login with Amazon:
*
* - `client_id`
* - `client_secret`
* - `authorize_scopes`
* - For Facebook:
*
* - `client_id`
* - `client_secret`
* - `authorize_scopes`
* - `api_version`
* - For Sign in with Apple:
*
* - `client_id`
* - `team_id`
* - `key_id`
* - `private_key`
* - `authorize_scopes`
* - For OIDC providers:
*
* - `client_id`
* - `client_secret`
* - `attributes_request_method`
* - `oidc_issuer`
* - `authorize_scopes`
* - `authorize_url` *if not available from discovery URL specified by oidc_issuer key*
* - `token_url` *if not available from discovery URL specified by oidc_issuer key*
* - `attributes_url` *if not available from discovery URL specified by oidc_issuer key*
* - `jwks_uri` *if not available from discovery URL specified by oidc_issuer key*
* - For SAML providers:
*
* - `MetadataFile` OR `MetadataURL`
* - `IDPSignout` (boolean) *optional*
* - `IDPInit` (boolean) *optional*
* - `RequestSigningAlgorithm` (string) *optional* - Only accepts `rsa-sha256`
* - `EncryptedResponses` (boolean) *optional*
*/
readonly identityProviderDetails: pulumi.Output<{
[key: string]: string;
}>;
/**
* The identity provider name.
*/
readonly identityProviderName: pulumi.Output<string>;
/**
* The identity provider type.
*/
readonly identityProviderType: pulumi.Output<enums.workspacesweb.IdentityProviderType>;
/**
* The ARN of the identity provider.
*/
readonly portalArn: pulumi.Output<string | undefined>;
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Create a IdentityProvider 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: IdentityProviderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a IdentityProvider resource.
*/
export interface IdentityProviderArgs {
/**
* The identity provider details. The following list describes the provider detail keys for each identity provider type.
*
* - For Google and Login with Amazon:
*
* - `client_id`
* - `client_secret`
* - `authorize_scopes`
* - For Facebook:
*
* - `client_id`
* - `client_secret`
* - `authorize_scopes`
* - `api_version`
* - For Sign in with Apple:
*
* - `client_id`
* - `team_id`
* - `key_id`
* - `private_key`
* - `authorize_scopes`
* - For OIDC providers:
*
* - `client_id`
* - `client_secret`
* - `attributes_request_method`
* - `oidc_issuer`
* - `authorize_scopes`
* - `authorize_url` *if not available from discovery URL specified by oidc_issuer key*
* - `token_url` *if not available from discovery URL specified by oidc_issuer key*
* - `attributes_url` *if not available from discovery URL specified by oidc_issuer key*
* - `jwks_uri` *if not available from discovery URL specified by oidc_issuer key*
* - For SAML providers:
*
* - `MetadataFile` OR `MetadataURL`
* - `IDPSignout` (boolean) *optional*
* - `IDPInit` (boolean) *optional*
* - `RequestSigningAlgorithm` (string) *optional* - Only accepts `rsa-sha256`
* - `EncryptedResponses` (boolean) *optional*
*/
identityProviderDetails: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The identity provider name.
*/
identityProviderName?: pulumi.Input<string>;
/**
* The identity provider type.
*/
identityProviderType: pulumi.Input<enums.workspacesweb.IdentityProviderType>;
/**
* The ARN of the identity provider.
*/
portalArn?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}