- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateAnycastIpListCommand
Creates an Anycast static IP list.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { CloudFrontClient, CreateAnycastIpListCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import
// const { CloudFrontClient, CreateAnycastIpListCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import
const client = new CloudFrontClient(config);
const input = { // CreateAnycastIpListRequest
Name: "STRING_VALUE", // required
IpCount: Number("int"), // required
Tags: { // Tags
Items: [ // TagList
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE",
},
],
},
};
const command = new CreateAnycastIpListCommand(input);
const response = await client.send(command);
// { // CreateAnycastIpListResult
// AnycastIpList: { // AnycastIpList
// Id: "STRING_VALUE", // required
// Name: "STRING_VALUE", // required
// Status: "STRING_VALUE", // required
// Arn: "STRING_VALUE", // required
// AnycastIps: [ // AnycastIps // required
// "STRING_VALUE",
// ],
// IpCount: Number("int"), // required
// LastModifiedTime: new Date("TIMESTAMP"), // required
// },
// ETag: "STRING_VALUE",
// };
CreateAnycastIpListCommand Input
See CreateAnycastIpListCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
IpCount Required | number | undefined | The number of static IP addresses that are allocated to the Anycast static IP list. |
Name Required | string | undefined | Name of the Anycast static IP list. |
Tags | Tags | undefined | A complex type that contains zero or more |
CreateAnycastIpListCommand Output
See CreateAnycastIpListCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
AnycastIpList | AnycastIpList | undefined | A response structure that includes the version identifier (ETag) and the created AnycastIpList structure. |
ETag | string | undefined | The version identifier for the current version of the Anycast static IP list. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDenied | client | Access denied. |
EntityAlreadyExists | client | The entity already exists. You must provide a unique entity. |
EntityLimitExceeded | client | The entity limit has been exceeded. |
InvalidArgument | client | An argument is invalid. |
InvalidTagging | client | The tagging specified is not valid. |
UnsupportedOperation | client | This operation is not supported in this Amazon Web Services Region. |
CloudFrontServiceException | Base exception class for all service exceptions from CloudFront service. |