Package software.amazon.awscdk.services.cognito

Interface CfnManagedLoginBranding.AssetTypeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnManagedLoginBranding.AssetTypeProperty.Jsii$Proxy

Enclosing class:

CfnManagedLoginBranding

@Stability(Stable)
public static interface CfnManagedLoginBranding.AssetTypeProperty
extends software.amazon.jsii.JsiiSerializable

An image file from a managed login branding style in a user pool.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 AssetTypeProperty assetTypeProperty = AssetTypeProperty.builder()
         .category("category")
         .colorMode("colorMode")
         .extension("extension")
         // the properties below are optional
         .bytes("bytes")
         .resourceId("resourceId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnManagedLoginBranding.AssetTypeProperty.Builder	A builder for CfnManagedLoginBranding.AssetTypeProperty
static final class	CfnManagedLoginBranding.AssetTypeProperty.Jsii$Proxy	An implementation for CfnManagedLoginBranding.AssetTypeProperty

Method Summary

Modifier and Type	Method	Description
static CfnManagedLoginBranding.AssetTypeProperty.Builder	builder()
default String	getBytes()	The image file, in Base64-encoded binary.
String	getCategory()	The category that the image corresponds to in your managed login configuration.
String	getColorMode()	The display-mode target of the asset: light, dark, or browser-adaptive.
String	getExtension()	The file type of the image file.
default String	getResourceId()	The ID of the asset.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCategory

@Stability(Stable)
@NotNull
String getCategory()

The category that the image corresponds to in your managed login configuration.

Managed login has asset categories for different types of logos, backgrounds, and icons.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-category

getColorMode

@Stability(Stable)
@NotNull
String getColorMode()

The display-mode target of the asset: light, dark, or browser-adaptive.

For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-colormode

getExtension

@Stability(Stable)
@NotNull
String getExtension()

The file type of the image file.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-extension

getBytes

@Stability(Stable)
@Nullable
default String getBytes()

The image file, in Base64-encoded binary.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-bytes

getResourceId

@Stability(Stable)
@Nullable
default String getResourceId()

The ID of the asset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-resourceid

builder

@Stability(Stable)
static CfnManagedLoginBranding.AssetTypeProperty.Builder builder()

Returns:

a CfnManagedLoginBranding.AssetTypeProperty.Builder of CfnManagedLoginBranding.AssetTypeProperty