- 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.
GetCloudFormationStackRecordsCommand
Returns the CloudFormation stack record created as a result of the create cloud formation stack
operation.
An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LightsailClient, GetCloudFormationStackRecordsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import
// const { LightsailClient, GetCloudFormationStackRecordsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import
const client = new LightsailClient(config);
const input = { // GetCloudFormationStackRecordsRequest
pageToken: "STRING_VALUE",
};
const command = new GetCloudFormationStackRecordsCommand(input);
const response = await client.send(command);
// { // GetCloudFormationStackRecordsResult
// cloudFormationStackRecords: [ // CloudFormationStackRecordList
// { // CloudFormationStackRecord
// name: "STRING_VALUE",
// arn: "STRING_VALUE",
// createdAt: new Date("TIMESTAMP"),
// location: { // ResourceLocation
// availabilityZone: "STRING_VALUE",
// regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "eu-north-1",
// },
// resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket",
// state: "Started" || "Succeeded" || "Failed",
// sourceInfo: [ // CloudFormationStackRecordSourceInfoList
// { // CloudFormationStackRecordSourceInfo
// resourceType: "ExportSnapshotRecord",
// name: "STRING_VALUE",
// arn: "STRING_VALUE",
// },
// ],
// destinationInfo: { // DestinationInfo
// id: "STRING_VALUE",
// service: "STRING_VALUE",
// },
// },
// ],
// nextPageToken: "STRING_VALUE",
// };
GetCloudFormationStackRecordsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
pageToken | string | undefined | The token to advance to the next page of results from your request. To get a page token, perform an initial |
GetCloudFormationStackRecordsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
cloudFormationStackRecords | CloudFormationStackRecord[] | undefined | A list of objects describing the CloudFormation stack records. |
nextPageToken | string | undefined | The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. |
AccountSetupInProgressException | client | Lightsail throws this exception when an account is still in the setup in progress state. |
InvalidInputException | client | Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia ( |
NotFoundException | client | Lightsail throws this exception when it cannot find a resource. |
OperationFailureException | client | Lightsail throws this exception when an operation fails to execute. |
ServiceException | server | A general service exception. |
UnauthenticatedException | client | Lightsail throws this exception when the user has not been authenticated. |
LightsailServiceException | Base exception class for all service exceptions from Lightsail service. |