destinations

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

Overview

Name	destinations
Type	Resource
Id	sumologic.logs_data_forwarding.destinations

Fields

The following fields are returned by SELECT queries:

getDataForwardingDestination

Data forwarding destination object requested.

Name	Datatype	Description
id	string	The unique identifier of the data forwarding destination. (example: 1)
accessKeyId	string	The AWS Access ID to access the S3 bucket. (example: accessKeyId)
authenticationMode	string	AWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased (example: RoleBased)
bucketName	string	The name of the Amazon S3 bucket. (pattern: (?!(^xn--|-s3alias$))^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$, example: df-bucket, x-pattern-message: Must be a valid AWS S3 Bucket name.)
createdAt	string (date-time)	Creation timestamp in UTC in RFC3339 format. (example: 2018-10-16T09:10:00Z)
createdBy	string	Identifier of the user who created the resource. (example: 0000000006743FDD)
description	string	Description of the S3 data forwarding destination.
destinationName	string	Name of the S3 data forwarding destination. (example: df-destination)
enabled	boolean	True if the destination is Active.
encrypted	boolean	Enable S3 server-side encryption.
invalidatedBySystem	boolean	True if invalidated by the system.
modifiedAt	string (date-time)	Last modification timestamp in UTC. (example: 2018-10-16T09:10:00Z)
modifiedBy	string	Identifier of the user who last modified the resource. (example: 0000000006743FE8)
region	string	The region where the S3 bucket is located. (example: us-east-1)
roleArn	string	The AWS Role ARN to access the S3 bucket. (example: roleArn)
secretAccessKey	string	The AWS Secret Key to access the S3 bucket. (example: secretAccessKey)

getDataForwardingBuckets

List of all S3 data forwarding destinations.

Name	Datatype	Description
data	array	List of data forwarding destinations.
nextToken	string	Next continuation token. (example: VEZuRU4veXF2UWFCUURYSDNQUzJxWlpRRUsvTlBieXA)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getDataForwardingDestination	select	id, region		Get an S3 data forwarding destination by the given identifier.
getDataForwardingBuckets	select	region	limit, token	Get a list of all Amazon S3 data forwarding destinations.
createDataForwardingBucket	insert	region, data__authenticationMode		Create a new Amazon S3 data forwarding destination.
deleteDataForwardingBucket	delete	id, region		Delete an existing Amazon S3 data forwarding destination with the given identifier.
UpdateDataForwardingBucket	exec	id, region, authenticationMode		Update an S3 data forwarding destination by 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.

Name	Datatype	Description
id	string	Identifier of the data forwarding destination to update. (example: 1)
region	string	SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2)
limit	integer (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.
token	string	Continuation 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

getDataForwardingDestination

Get an S3 data forwarding destination by the given identifier.

SELECT
id,
accessKeyId,
authenticationMode,
bucketName,
createdAt,
createdBy,
description,
destinationName,
enabled,
encrypted,
invalidatedBySystem,
modifiedAt,
modifiedBy,
region,
roleArn,
secretAccessKey
FROM sumologic.logs_data_forwarding.destinations
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

getDataForwardingBuckets

Get a list of all Amazon S3 data forwarding destinations.

SELECT
data,
nextToken
FROM sumologic.logs_data_forwarding.destinations
WHERE region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND token = '{{ token }}'
;

INSERT examples

createDataForwardingBucket

Create a new Amazon S3 data forwarding destination.

INSERT INTO sumologic.logs_data_forwarding.destinations (
data__destinationName,
data__description,
data__authenticationMode,
data__accessKeyId,
data__secretAccessKey,
data__roleArn,
data__region,
data__encrypted,
data__enabled,
data__bucketName,
region
)
SELECT 
'{{ destinationName }}',
'{{ description }}',
'{{ authenticationMode }}' /* required */,
'{{ accessKeyId }}',
'{{ secretAccessKey }}',
'{{ roleArn }}',
'{{ region }}',
{{ encrypted }},
{{ enabled }},
'{{ bucketName }}',
'{{ region }}'
RETURNING
id,
accessKeyId,
authenticationMode,
bucketName,
createdAt,
createdBy,
description,
destinationName,
enabled,
encrypted,
invalidatedBySystem,
modifiedAt,
modifiedBy,
region,
roleArn,
secretAccessKey
;

Manifest

# Description fields are for documentation purposes
- name: destinations
  props:
    - name: region
      value: string
      description: Required parameter for the destinations resource.
    - name: destinationName
      value: string
      description: |
        Name of the S3 data forwarding destination.
    - name: description
      value: string
      description: |
        Description of the S3 data forwarding destination.
    - name: authenticationMode
      value: string
      description: |
        AWS IAM authentication method used for access. Possible values are: 1. `AccessKey` 2. `RoleBased`
    - name: accessKeyId
      value: string
      description: |
        The AWS Access ID to access the S3 bucket.
    - name: secretAccessKey
      value: string
      description: |
        The AWS Secret Key to access the S3 bucket.
    - name: roleArn
      value: string
      description: |
        The AWS Role ARN to access the S3 bucket.
    - name: region
      value: string
      description: |
        The region where the S3 bucket is located.
    - name: encrypted
      value: boolean
      description: |
        Enable S3 server-side encryption.
    - name: enabled
      value: boolean
      description: |
        True if the destination is Active.
    - name: bucketName
      value: string
      description: |
        The name of the Amazon S3 bucket.

DELETE examples

deleteDataForwardingBucket

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
;

Lifecycle Methods

UpdateDataForwardingBucket

Update an S3 data forwarding destination by the given identifier.

EXEC sumologic.logs_data_forwarding.destinations.UpdateDataForwardingBucket 
@id='{{ id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"destinationName": "{{ destinationName }}", 
"description": "{{ description }}", 
"authenticationMode": "{{ authenticationMode }}", 
"accessKeyId": "{{ accessKeyId }}", 
"secretAccessKey": "{{ secretAccessKey }}", 
"roleArn": "{{ roleArn }}", 
"region": "{{ region }}", 
"encrypted": {{ encrypted }}, 
"enabled": {{ enabled }}
}'
;