Create or update the CloudWatch Metric Export configuration for a cluster

curl --request POST \ --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/metricexport/cloudwatch \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ --json '{"external_id":"example_external_id","log_group_name":"example","role_arn":"arn:aws:iam::account:role/ExampleRole","target_region":"us-east-1"}'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id

string

required

Body

application/json

role_arn

string

required

role_arn is the IAM role used to upload metric segments to the target AWS account.

external_id

string

external_id to include when assuming the IAM role specified by role_arn. Optional. A specific value may be required by the role's trust policy. Only supported for Advanced clusters. If provided for a Standard cluster, the request is rejected.

log_group_name

string

log_group_name is the customized log group name.

target_region

string

target_region specifies the specific AWS region that the metrics will be exported to.

Response

A successful response.

cluster_id

string

required

role_arn

string

required

role_arn is the IAM role used to upload metric segments to the target AWS account.

external_id

string

external_id, if set, is included when assuming the IAM role. Supported for Advanced clusters only.

log_group_name

string

log_group_name is the customized log group name.

status

enum<string>

Available options:

NOT_DEPLOYED,

DISABLING,

ENABLING,

ENABLED,

ERROR

target_region

string

target_region specifies the specific AWS region that the metrics will be exported to.

user_message

string

Overview

Endpoints

Create or update the CloudWatch Metric Export configuration for a cluster

Authorizations

Path Parameters

Body

Response