@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)
96 lines (95 loc) • 5.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::Cognito::ManagedLoginBranding
*/
export declare class ManagedLoginBranding extends pulumi.CustomResource {
/**
* Get an existing ManagedLoginBranding 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): ManagedLoginBranding;
/**
* Returns true if the given object is an instance of ManagedLoginBranding. 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 ManagedLoginBranding;
/**
* An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
*/
readonly assets: pulumi.Output<outputs.cognito.ManagedLoginBrandingAssetType[] | undefined>;
/**
* The app client that you want to assign the branding style to. Each style is linked to an app client until you delete it.
*/
readonly clientId: pulumi.Output<string | undefined>;
/**
* The ID of the managed login branding style.
*/
readonly managedLoginBrandingId: pulumi.Output<string>;
/**
* When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style.
*/
readonly returnMergedResources: pulumi.Output<boolean | undefined>;
/**
* A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Cognito::ManagedLoginBranding` for more information about the expected schema for this property.
*/
readonly settings: pulumi.Output<any | undefined>;
/**
* When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding editor.
*
* When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request.
*/
readonly useCognitoProvidedValues: pulumi.Output<boolean | undefined>;
/**
* The user pool where the branding style is assigned.
*/
readonly userPoolId: pulumi.Output<string>;
/**
* Create a ManagedLoginBranding 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: ManagedLoginBrandingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ManagedLoginBranding resource.
*/
export interface ManagedLoginBrandingArgs {
/**
* An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
*/
assets?: pulumi.Input<pulumi.Input<inputs.cognito.ManagedLoginBrandingAssetTypeArgs>[]>;
/**
* The app client that you want to assign the branding style to. Each style is linked to an app client until you delete it.
*/
clientId?: pulumi.Input<string>;
/**
* When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style.
*/
returnMergedResources?: pulumi.Input<boolean>;
/**
* A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Cognito::ManagedLoginBranding` for more information about the expected schema for this property.
*/
settings?: any;
/**
* When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding editor.
*
* When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request.
*/
useCognitoProvidedValues?: pulumi.Input<boolean>;
/**
* The user pool where the branding style is assigned.
*/
userPoolId: pulumi.Input<string>;
}