1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cognito
  5. getManagedLoginBranding

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.cognito.getManagedLoginBranding

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

    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:

    ManagedLoginBrandingId string
    The ID of the managed login branding style.
    UserPoolId string
    The user pool where the branding style is assigned.
    ManagedLoginBrandingId string
    The ID of the managed login branding style.
    UserPoolId string
    The user pool where the branding style is assigned.
    managedLoginBrandingId String
    The ID of the managed login branding style.
    userPoolId String
    The user pool where the branding style is assigned.
    managedLoginBrandingId string
    The ID of the managed login branding style.
    userPoolId string
    The user pool where the branding style is assigned.
    managed_login_branding_id str
    The ID of the managed login branding style.
    user_pool_id str
    The user pool where the branding style is assigned.
    managedLoginBrandingId String
    The ID of the managed login branding style.
    userPoolId String
    The user pool where the branding style is assigned.

    getManagedLoginBranding Result

    The following output properties are available:

    Assets List<Pulumi.AwsNative.Cognito.Outputs.ManagedLoginBrandingAssetType>
    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.
    ManagedLoginBrandingId string
    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.

    UseCognitoProvidedValues bool

    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 for Settings and Assets in the request.

    Assets []ManagedLoginBrandingAssetType
    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.
    ManagedLoginBrandingId string
    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.

    UseCognitoProvidedValues bool

    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 for Settings and Assets in the request.

    assets List<ManagedLoginBrandingAssetType>
    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.
    managedLoginBrandingId String
    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.

    useCognitoProvidedValues Boolean

    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 for Settings and Assets in the request.

    assets ManagedLoginBrandingAssetType[]
    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.
    managedLoginBrandingId string
    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.

    useCognitoProvidedValues boolean

    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 for Settings and Assets in the request.

    assets Sequence[ManagedLoginBrandingAssetType]
    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_branding_id str
    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_provided_values bool

    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 for Settings and Assets 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.
    managedLoginBrandingId String
    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.

    useCognitoProvidedValues Boolean

    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 for Settings and Assets in the request.

    Supporting Types

    ManagedLoginBrandingAssetType

    ManagedLoginBrandingCategoryType

    ManagedLoginBrandingColorModeType

    ManagedLoginBrandingExtensionType

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi