The settings for an instance in a gateway.
Contents
- bridgePlacement
-
The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.
Type: String
Valid Values:
AVAILABLE | LOCKEDRequired: Yes
- connectionStatus
-
The connection state of the instance.
Type: String
Valid Values:
CONNECTED | DISCONNECTEDRequired: Yes
- gatewayArn
-
The Amazon Resource Name (ARN) of the instance.
Type: String
Required: Yes
- gatewayInstanceArn
-
The ARN of the gateway.
Type: String
Required: Yes
- instanceId
-
The instance ID generated by the SSM install. This will begin with "mi-".
Type: String
Required: Yes
- instanceState
-
The status of the instance.
Type: String
Valid Values:
REGISTERING | ACTIVE | DEREGISTERING | DEREGISTERED | REGISTRATION_ERROR | DEREGISTRATION_ERRORRequired: Yes
- runningBridgeCount
-
The running bridge count.
Type: Integer
Required: Yes
- instanceMessages
-
Messages with information about the gateway.
Type: Array of MessageDetail objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
