Class UpdateEndpointGroupCommandProtected

Update an endpoint group. A resource must be valid and active when you add it as an endpoint.

Example

Use a bare-bones client and the command you need to make an API call.

import { GlobalAcceleratorClient, UpdateEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import
// const { GlobalAcceleratorClient, UpdateEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import
const client = new GlobalAcceleratorClient(config);
const input = { // UpdateEndpointGroupRequest
  EndpointGroupArn: "STRING_VALUE", // required
  EndpointConfigurations: [ // EndpointConfigurations
    { // EndpointConfiguration
      EndpointId: "STRING_VALUE",
      Weight: Number("int"),
      ClientIPPreservationEnabled: true || false,
    },
  ],
  TrafficDialPercentage: Number("float"),
  HealthCheckPort: Number("int"),
  HealthCheckProtocol: "TCP" || "HTTP" || "HTTPS",
  HealthCheckPath: "STRING_VALUE",
  HealthCheckIntervalSeconds: Number("int"),
  ThresholdCount: Number("int"),
  PortOverrides: [ // PortOverrides
    { // PortOverride
      ListenerPort: Number("int"),
      EndpointPort: Number("int"),
    },
  ],
};
const command = new UpdateEndpointGroupCommand(input);
const response = await client.send(command);
// { // UpdateEndpointGroupResponse
//   EndpointGroup: { // EndpointGroup
//     EndpointGroupArn: "STRING_VALUE",
//     EndpointGroupRegion: "STRING_VALUE",
//     EndpointDescriptions: [ // EndpointDescriptions
//       { // EndpointDescription
//         EndpointId: "STRING_VALUE",
//         Weight: Number("int"),
//         HealthState: "INITIAL" || "HEALTHY" || "UNHEALTHY",
//         HealthReason: "STRING_VALUE",
//         ClientIPPreservationEnabled: true || false,
//       },
//     ],
//     TrafficDialPercentage: Number("float"),
//     HealthCheckPort: Number("int"),
//     HealthCheckProtocol: "TCP" || "HTTP" || "HTTPS",
//     HealthCheckPath: "STRING_VALUE",
//     HealthCheckIntervalSeconds: Number("int"),
//     ThresholdCount: Number("int"),
//     PortOverrides: [ // PortOverrides
//       { // PortOverride
//         ListenerPort: Number("int"),
//         EndpointPort: Number("int"),
//       },
//     ],
//   },
// };

Param

UpdateEndpointGroupCommandInput

Returns

UpdateEndpointGroupCommandOutput

See

• UpdateEndpointGroupCommandInput for command's input shape.
• UpdateEndpointGroupCommandOutput for command's response shape.
• config for GlobalAcceleratorClient's config shape.

Throws

AccessDeniedException (client fault)

You don't have access permission.

Throws

EndpointGroupNotFoundException (client fault)

The endpoint group that you specified doesn't exist.

Throws

InternalServiceErrorException (server fault)

There was an internal error for Global Accelerator.

Throws

InvalidArgumentException (client fault)

An argument that you specified is invalid.

Throws

LimitExceededException (client fault)

Processing your request would cause you to exceed an Global Accelerator limit.

Throws

GlobalAcceleratorServiceException

Base exception class for all service exceptions from GlobalAccelerator service.