v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

logsDataForwardingManagement

Update an S3 data forwarding destination.

Update an S3 data forwarding destination by the given identifier.

put/v1/logsDataForwarding/destinations/{id}

Path parameters

idstring required

Identifier of the data forwarding destination to update.

Request body

destinationNamestring

Name of the S3 data forwarding destination.

descriptionstring

Description of the S3 data forwarding destination.

authenticationModestring required

AWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased

accessKeyIdstring

The AWS Access ID to access the S3 bucket.

secretAccessKeystring

The AWS Secret Key to access the S3 bucket.

roleArnstring

The AWS Role ARN to access the S3 bucket.

regionstring

The region where the S3 bucket is located.

encryptedboolean

Enable S3 server-side encryption.

enabledboolean

True if the destination is Active.

Example request

{
  "destinationName": "df-destination",
  "authenticationMode": "RoleBased",
  "accessKeyId": "accessKeyId",
  "secretAccessKey": "secretAccessKey",
  "roleArn": "roleArn",
  "region": "us-east-1",
  "enabled": true
}

Response

The data forwarding destination has been updated.

destinationNamestring required

Name of the S3 data forwarding destination.

descriptionstring

Description of the S3 data forwarding destination.

authenticationModestring required

AWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased

accessKeyIdstring

The AWS Access ID to access the S3 bucket.

secretAccessKeystring

The AWS Secret Key to access the S3 bucket.

roleArnstring

The AWS Role ARN to access the S3 bucket.

regionstring

The region where the S3 bucket is located.

encryptedboolean

Enable S3 server-side encryption.

enabledboolean

True if the destination is Active.

bucketNamestring required

The name of the Amazon S3 bucket.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring required

The unique identifier of the data forwarding destination.

invalidatedBySystemboolean

True if invalidated by the system.

Example response

{
  "destinationName": "df-destination",
  "authenticationMode": "RoleBased",
  "accessKeyId": "accessKeyId",
  "secretAccessKey": "secretAccessKey",
  "roleArn": "roleArn",
  "region": "us-east-1",
  "enabled": true,
  "bucketName": "df-bucket",
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8",
  "id": "1"
}