Skip to main content

destinations

Creates, updates, deletes, gets or lists a destinations resource.

Overview​

Namedestinations
TypeResource
Idsumologic.logs_data_forwarding.destinations

Fields​

The following fields are returned by SELECT queries:

Data forwarding destination object requested.

NameDatatypeDescription
idstringThe unique identifier of the data forwarding destination. (example: 1)
access_key_idstringThe AWS Access ID to access the S3 bucket. (example: accessKeyId) (wire: accessKeyId)
bucket_namestringThe name of the Amazon S3 bucket. (pattern: <code>(?!(^xn--|-s3alias$))^[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]$</code>, example: df-bucket, x-pattern-message: Must be a valid AWS S3 Bucket name.) (wire: bucketName)
destination_namestringName of the S3 data forwarding destination. (example: df-destination) (wire: destinationName)
authentication_modestringAWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased (example: RoleBased) (wire: authenticationMode)
created_atstring (date-time)Creation timestamp in UTC in [RFC3339](https:​//tools.ietf.org/html/rfc3339) format. (example: 2018-10-16T09:10:00.000Z) (wire: createdAt)
created_bystringIdentifier of the user who created the resource. (example: 0000000006743FDD) (wire: createdBy)
descriptionstringDescription of the S3 data forwarding destination.
enabledbooleanTrue if the destination is Active.
encryptedbooleanEnable S3 server-side encryption.
invalidated_by_systembooleanTrue if invalidated by the system. (wire: invalidatedBySystem)
modified_atstring (date-time)Last modification timestamp in UTC. (example: 2018-10-16T09:10:00.000Z) (wire: modifiedAt)
modified_bystringIdentifier of the user who last modified the resource. (example: 0000000006743FE8) (wire: modifiedBy)
regionstringThe region where the S3 bucket is located. (example: us-east-1)
role_arnstringThe AWS Role ARN to access the S3 bucket. (example: roleArn) (wire: roleArn)
secret_access_keystringThe AWS Secret Key to access the S3 bucket. (example: secretAccessKey) (wire: secretAccessKey)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectid, regionGet an S3 data forwarding destination by the given identifier.
listselectregionlimit, tokenGet a list of all Amazon S3 data forwarding destinations.
createinsertregion, authentication_mode, bucket_name, destination_nameCreate a new Amazon S3 data forwarding destination.
updateupdateid, region, authentication_modeUpdate an S3 data forwarding destination by the given identifier.
deletedeleteid, regionDelete an existing Amazon S3 data forwarding destination with the given identifier.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
idstringIdentifier of the data forwarding destination to delete. (example: 1)
regionstringSumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)
limitinteger (int32)Limit the number of data forwarding destinations returned in the response. The number of data forwarding destinations returned may be less than the limit.
tokenstringContinuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

SELECT examples​

Get an S3 data forwarding destination by the given identifier.

SELECT
id,
access_key_id,
bucket_name,
destination_name,
authentication_mode,
created_at,
created_by,
description,
enabled,
encrypted,
invalidated_by_system,
modified_at,
modified_by,
region,
role_arn,
secret_access_key
FROM sumologic.logs_data_forwarding.destinations
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

INSERT examples​

Create a new Amazon S3 data forwarding destination.

INSERT INTO sumologic.logs_data_forwarding.destinations (
destination_name,
description,
authentication_mode,
access_key_id,
secret_access_key,
role_arn,
region,
encrypted,
enabled,
bucket_name,
region
)
SELECT 
'{{ destination_name }}' /* required */,
'{{ description }}',
'{{ authentication_mode }}' /* required */,
'{{ access_key_id }}',
'{{ secret_access_key }}',
'{{ role_arn }}',
'{{ region }}',
{{ encrypted }},
{{ enabled }},
'{{ bucket_name }}' /* required */,
'{{ region }}'
RETURNING
id,
access_key_id,
bucket_name,
destination_name,
authentication_mode,
created_at,
created_by,
description,
enabled,
encrypted,
invalidated_by_system,
modified_at,
modified_by,
region,
role_arn,
secret_access_key
;

UPDATE examples​

Update an S3 data forwarding destination by the given identifier.

UPDATE sumologic.logs_data_forwarding.destinations
SET 
destination_name = '{{ destination_name }}',
description = '{{ description }}',
authentication_mode = '{{ authentication_mode }}',
access_key_id = '{{ access_key_id }}',
secret_access_key = '{{ secret_access_key }}',
role_arn = '{{ role_arn }}',
region = '{{ region }}',
encrypted = {{ encrypted }},
enabled = {{ enabled }}
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
AND authentication_mode = '{{ authentication_mode }}' --required
RETURNING
id,
access_key_id,
bucket_name,
destination_name,
authentication_mode,
created_at,
created_by,
description,
enabled,
encrypted,
invalidated_by_system,
modified_at,
modified_by,
region,
role_arn,
secret_access_key;

DELETE examples​

Delete an existing Amazon S3 data forwarding destination with the given identifier.

DELETE FROM sumologic.logs_data_forwarding.destinations
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
;
Last updated on