nifty-create-elastic-load-balancer

Description

マルチロードバランサーを作成します。

1回のリクエストで、1つのポート定義を作成できます。

マルチロードバランサーの作成後、サーバーを追加する場合は、以下のAPIを実行する必要があります。

マルチロードバランサーでSSLアクセラレーター設定をする場合は、プロトコル「HTTPS」とSSL証明書の発行識別子を指定して作成してください。SSLアクセラレーター設定しない場合は、プロトコル「TCP」で必要ポートを指定して作成していただく必要があります。

ヘルスチェックの設定でヘルスチェックパス、およびヘルスチェック期待値を指定するためには、ヘルスチェックプロトコルが「HTTP」もしくは「HTTPS」である必要があります。

作成したマルチロードバランサーの内容は、API「NiftyDescribeElasticLoadBalancers 」で確認できます。

See also: NIFCLOUD API Documentation

Synopsis

  nifty-create-elastic-load-balancer
[--accounting-type <value>]
--availability-zones <value>
[--elastic-load-balancer-name <value>]
--listeners <value>
[--network-interface <value>]
[--network-volume <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--accounting-type (string)

Possible values:

  • 1

  • 2

--availability-zones (list) (string)

Syntax:

"string" "string" ...

--elastic-load-balancer-name (string)

--listeners (list) (structure)

BalancingType -> (integer)

Description -> (string)

ElasticLoadBalancerPort -> (integer)

InstancePort -> (integer)

ListOfRequestInstances -> (list)

(structure)

InstanceId -> (string)

InstanceUniqueId -> (string)

Protocol -> (string)

RequestHealthCheck -> (structure)

Interval -> (integer)

ListOfRequestExpectation -> (list)

(structure)

HttpCode -> (string)

Path -> (string)

Target -> (string)

UnhealthyThreshold -> (integer)

RequestSession -> (structure)

RequestStickinessPolicy -> (structure)

Enable -> (boolean)

ExpirationPeriod -> (integer)

Method -> (string)

RequestSorryPage -> (structure)

Enable -> (boolean)

RedirectUrl -> (string)

SSLCertificateId -> (string)

JSON Syntax:

[
  {
    "BalancingType": integer,
    "Description": "string",
    "ElasticLoadBalancerPort": integer,
    "InstancePort": integer,
    "ListOfRequestInstances": [
      {
        "InstanceId": "string",
        "InstanceUniqueId": "string"
      }
      ...
    ],
    "Protocol": "TCP"|"UDP"|"HTTP"|"HTTPS",
    "RequestHealthCheck": {
      "Interval": integer,
      "ListOfRequestExpectation": [
        {
          "HttpCode": "1xx"|"2xx"|"3xx"|"4xx"|"5xx"
        }
        ...
      ],
      "Path": "string",
      "Target": "string",
      "UnhealthyThreshold": integer
    },
    "RequestSession": {
      "RequestStickinessPolicy": {
        "Enable": true|false,
        "ExpirationPeriod": integer,
        "Method": "1"|"2"
      }
    },
    "RequestSorryPage": {
      "Enable": true|false,
      "RedirectUrl": "string"
    },
    "SSLCertificateId": "string"
  }
  ...
]

--network-interface (list) (structure)

IpAddress -> (string)

IsVipNetwork -> (boolean)

ListOfRequestSystemIpAddresses -> (list)

(structure)

SystemIpAddress -> (string)

NetworkId -> (string)

NetworkName -> (string)

Shorthand Syntax:

IpAddress=string,IsVipNetwork=boolean,ListOfRequestSystemIpAddresses=[{SystemIpAddress=string},{SystemIpAddress=string}],NetworkId=string,NetworkName=string ...

JSON Syntax:

[
  {
    "IpAddress": "string",
    "IsVipNetwork": true|false,
    "ListOfRequestSystemIpAddresses": [
      {
        "SystemIpAddress": "string"
      }
      ...
    ],
    "NetworkId": "string",
    "NetworkName": "string"
  }
  ...
]

--network-volume (integer)

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on

  • off

  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

NiftyCreateElasticLoadBalancerResult -> (structure)

DNSName -> (string)

ResponseMetadata -> (structure)

RequestId -> (string)