We recommend new projects start with resources from the AWS provider.
aws-native.cognito.getManagedLoginBranding
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Cognito::ManagedLoginBranding
Using getManagedLoginBranding
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getManagedLoginBranding(args: GetManagedLoginBrandingArgs, opts?: InvokeOptions): Promise<GetManagedLoginBrandingResult>
function getManagedLoginBrandingOutput(args: GetManagedLoginBrandingOutputArgs, opts?: InvokeOptions): Output<GetManagedLoginBrandingResult>
def get_managed_login_branding(managed_login_branding_id: Optional[str] = None,
user_pool_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetManagedLoginBrandingResult
def get_managed_login_branding_output(managed_login_branding_id: Optional[pulumi.Input[str]] = None,
user_pool_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetManagedLoginBrandingResult]
func LookupManagedLoginBranding(ctx *Context, args *LookupManagedLoginBrandingArgs, opts ...InvokeOption) (*LookupManagedLoginBrandingResult, error)
func LookupManagedLoginBrandingOutput(ctx *Context, args *LookupManagedLoginBrandingOutputArgs, opts ...InvokeOption) LookupManagedLoginBrandingResultOutput
> Note: This function is named LookupManagedLoginBranding
in the Go SDK.
public static class GetManagedLoginBranding
{
public static Task<GetManagedLoginBrandingResult> InvokeAsync(GetManagedLoginBrandingArgs args, InvokeOptions? opts = null)
public static Output<GetManagedLoginBrandingResult> Invoke(GetManagedLoginBrandingInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetManagedLoginBrandingResult> getManagedLoginBranding(GetManagedLoginBrandingArgs args, InvokeOptions options)
public static Output<GetManagedLoginBrandingResult> getManagedLoginBranding(GetManagedLoginBrandingArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:cognito:getManagedLoginBranding
arguments:
# arguments dictionary
The following arguments are supported:
- Managed
Login stringBranding Id - The ID of the managed login branding style.
- User
Pool stringId - The user pool where the branding style is assigned.
- Managed
Login stringBranding Id - The ID of the managed login branding style.
- User
Pool stringId - The user pool where the branding style is assigned.
- managed
Login StringBranding Id - The ID of the managed login branding style.
- user
Pool StringId - The user pool where the branding style is assigned.
- managed
Login stringBranding Id - The ID of the managed login branding style.
- user
Pool stringId - The user pool where the branding style is assigned.
- managed_
login_ strbranding_ id - The ID of the managed login branding style.
- user_
pool_ strid - The user pool where the branding style is assigned.
- managed
Login StringBranding Id - The ID of the managed login branding style.
- user
Pool StringId - The user pool where the branding style is assigned.
getManagedLoginBranding Result
The following output properties are available:
- Assets
List<Pulumi.
Aws Native. Cognito. Outputs. Managed Login Branding Asset Type> - 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.
- Managed
Login stringBranding Id - The ID of the managed login branding style.
- Settings object
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 for
AWS::Cognito::ManagedLoginBranding
for more information about the expected schema for this property.- Use
Cognito boolProvided Values 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 designer.
When you specify
true
for this option, you must also omit values forSettings
andAssets
in the request.
- Assets
[]Managed
Login Branding Asset Type - 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.
- Managed
Login stringBranding Id - The ID of the managed login branding style.
- Settings interface{}
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 for
AWS::Cognito::ManagedLoginBranding
for more information about the expected schema for this property.- Use
Cognito boolProvided Values 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 designer.
When you specify
true
for this option, you must also omit values forSettings
andAssets
in the request.
- assets
List<Managed
Login Branding Asset Type> - 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.
- managed
Login StringBranding Id - The ID of the managed login branding style.
- settings Object
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 for
AWS::Cognito::ManagedLoginBranding
for more information about the expected schema for this property.- use
Cognito BooleanProvided Values 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 designer.
When you specify
true
for this option, you must also omit values forSettings
andAssets
in the request.
- assets
Managed
Login Branding Asset Type[] - 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.
- managed
Login stringBranding Id - The ID of the managed login branding style.
- settings any
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 for
AWS::Cognito::ManagedLoginBranding
for more information about the expected schema for this property.- use
Cognito booleanProvided Values 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 designer.
When you specify
true
for this option, you must also omit values forSettings
andAssets
in the request.
- assets
Sequence[Managed
Login Branding Asset Type] - 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.
- managed_
login_ strbranding_ id - The ID of the managed login branding style.
- settings Any
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 for
AWS::Cognito::ManagedLoginBranding
for more information about the expected schema for this property.- use_
cognito_ boolprovided_ values 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 designer.
When you specify
true
for this option, you must also omit values forSettings
andAssets
in the request.
- assets List<Property Map>
- 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.
- managed
Login StringBranding Id - The ID of the managed login branding style.
- settings Any
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 for
AWS::Cognito::ManagedLoginBranding
for more information about the expected schema for this property.- use
Cognito BooleanProvided Values 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 designer.
When you specify
true
for this option, you must also omit values forSettings
andAssets
in the request.
Supporting Types
ManagedLoginBrandingAssetType
- category "FAVICON_ICO" | "FAVICON_SVG" | "EMAIL_GRAPHIC" | "SMS_GRAPHIC" | "AUTH_APP_GRAPHIC" | "PASSWORD_GRAPHIC" | "PASSKEY_GRAPHIC" | "PAGE_HEADER_LOGO" | "PAGE_HEADER_BACKGROUND" | "PAGE_FOOTER_LOGO" | "PAGE_FOOTER_BACKGROUND" | "PAGE_BACKGROUND" | "FORM_BACKGROUND" | "FORM_LOGO" | "IDP_BUTTON_ICON"
- color
Mode "LIGHT" | "DARK" | "DYNAMIC" - extension "ICO" | "JPEG" | "PNG" | "SVG" | "WEBP"
- bytes String
- resource
Id String
ManagedLoginBrandingCategoryType
ManagedLoginBrandingColorModeType
ManagedLoginBrandingExtensionType
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.