WorkSpaces カスタムブランドを試してみた。

2023.02.03

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

WorkSpaces カスタムブランドとは?

APIを使用して、WorkSpaces ログインページの外観をカスタマイズし、独自のブランディングを作成することができます。WorkSpacesのログインページでは、以下の要素をカスタマイズすることができます。

  • Support link: サポート ページへのリンクまたはEメールを指定できます。SupportEmail属性またはSupportLink属性を指定できます。両方の属性を同時に使用することはできません。
  • Logo: ログイン ページのロゴを Logo 属性でカスタマイズすることができます。
  • Forgot password link: ForgotPasswordLink 属性を使用して、パスワードを忘れた場合のリンクを指定します。
  • Login message: LoginMessage属性を使用して、ログイン ページのメッセージをカスタマイズすることができます。

WorkSpaces ログインページは、Windows、Linux、Android、MacOS、iOS、および Web アクセス クライアント用にカスタマイズできます。この記事では、WorkSpaces のログインページのロゴとログイン メッセージをカスタマイズしてみました。

やってみた

前提条件

  • WorkSpace を作成しておきます。
  • WorkSpaces クライアントをダウンロードしてインストールしておきます。
  • OS に基づいて PC に AWS CLI をインストールしてセットアップしておきます。
  • Python と boto3 をインストールしておきます。

 

WorkSpaceのブランディングをカスタマイズする

  • 次のコードで python ファイルを作成しておきます。[CustomizeWorkSpaceBranding.py]
  • コードで次の属性の値を指定しておきます。
    • Logo image path
    • directory Id
    • region
    • DeviceType : DeviceTypeWindows | DeviceTypeOsx (For macOS) | DeviceTypeAndroid | DeviceTypeIos | DeviceTypeLinux | DeviceTypeWeb
    • SupportEmail (or) SupportLink, ForgotPasswordLink and LoginMessage.

 

import boto3

with open("/Users/userName/Desktop/logo.png", "rb") as imageFile:
    f = imageFile.read()
    bytes = bytearray(f)

client = boto3.client('workspaces', region_name='us-east-1')
response = client.import_client_branding(
    ResourceId='d-xxxxxxxx',
    DeviceTypeOsx={
        'Logo': bytes,
        #'SupportEmail': '',
        #'SupportLink': '',
        #'ForgotPasswordLink': '',
        'LoginMessage': {
            'en_US': 'WorkSpaces testing'
        }
    }
)

 

  • 次のコマンドを使用して Python コードを実行します。
python3 CustomizeWorkSpaceBranding.py

 

確認する

  • カスタマイズ前の WorkSpaces ログインページです。

 

  • カスタマイズ後、ロゴとログインメッセージが変更されました。

 

まとめ

WorkSpaces のログインページのロゴとログイン メッセージをカスタマイズしてみました。WorkSpaces ログインページの他の要素をカスタマイズしてことができます。

Reference: Customize WorkSpace branding