AWS::EC2::CapacityManagerDataExport - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EC2::CapacityManagerDataExport

Creates a new data export configuration for EC2 Capacity Manager. This allows you to automatically export capacity usage data to an S3 bucket on a scheduled basis. The exported data includes metrics for On-Demand, Spot, and Capacity Reservations usage across your organization.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::CapacityManagerDataExport",
  "Properties" : {
      "OutputFormat" : String,
      "S3BucketName" : String,
      "S3BucketPrefix" : String,
      "Schedule" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::EC2::CapacityManagerDataExport
Properties:
  OutputFormat: String
  S3BucketName: String
  S3BucketPrefix: String
  Schedule: String
  Tags: 
    - Tag

Properties

OutputFormat

The file format of the exported data.

Required: Yes

Type: String

Allowed values: csv | parquet

Update requires: Replacement

S3BucketName

The name of the S3 bucket where export files are delivered.

Required: Yes

Type: String

Update requires: Replacement

S3BucketPrefix

The S3 key prefix used for organizing export files within the bucket.

Required: No

Type: String

Update requires: Replacement

Schedule

The frequency at which data exports are generated.

Required: Yes

Type: String

Allowed values: hourly

Update requires: Replacement

Tags

The tags associated with the data export configuration.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the export ID, such as cmde-0f3f217ee9a5baead.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CapacityManagerDataExportId

The unique identifier for the data export configuration.