ingestion_destinations

Creates, updates, deletes, gets or lists an ingestion_destinations resource.

Overview

Name	ingestion_destinations
Type	Resource
Id	aws.appfabric.ingestion_destinations

Fields

The following fields are returned by SELECT queries:

get_ingestion_destination

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the ingestion destination. (pattern: <code>arn:.+</code>)
created_at	string (date-time)	The timestamp of when the ingestion destination was created.
destination_configuration	object	Contains information about the destination of ingested data.
ingestion_arn	string	The Amazon Resource Name (ARN) of the ingestion. (pattern: <code>arn:.+</code>)
processing_configuration	object	Contains information about how ingested data is processed.
status	string	The state of the ingestion destination. The following states are possible: Active: The ingestion destination is active and is ready to be used. Failed: The ingestion destination has failed. If the ingestion destination is in this state, you should verify the ingestion destination configuration and try again. (Active, Failed)
status_reason	string	The reason for the current status of the ingestion destination. Only present when the status of ingestion destination is Failed.
updated_at	string (date-time)	The timestamp of when the ingestion destination was last updated.

list_ingestion_destinations

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the ingestion destination. (pattern: <code>arn:.+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ingestion_destination	select	app_bundle_identifier, ingestion_identifier, ingestion_destination_identifier, region		Returns information about an ingestion destination.
list_ingestion_destinations	select	app_bundle_identifier, ingestion_identifier, region	maxResults, nextToken	Returns a list of all ingestion destinations configured for an ingestion.
create_ingestion_destination	insert	app_bundle_identifier, ingestion_identifier, region, processingConfiguration, destinationConfiguration		Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.
update_ingestion_destination	update	app_bundle_identifier, ingestion_identifier, ingestion_destination_identifier, region, destinationConfiguration		Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.
delete_ingestion_destination	delete	app_bundle_identifier, ingestion_identifier, ingestion_destination_identifier, region		Deletes an ingestion destination. This deletes the association between an ingestion and it's destination. It doesn't delete previously ingested data or the storage destination, such as the Amazon S3 bucket where the data is delivered. If the ingestion destination is deleted while the associated ingestion is enabled, the ingestion will fail and is eventually disabled.

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
app_bundle_identifier	string	The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestion_destination_identifier	string	The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
ingestion_identifier	string	The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
nextToken	string	If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

SELECT examples

get_ingestion_destination

Returns information about an ingestion destination.

SELECT
arn,
created_at,
destination_configuration,
ingestion_arn,
processing_configuration,
status,
status_reason,
updated_at
FROM aws.appfabric.ingestion_destinations
WHERE app_bundle_identifier = '{{ app_bundle_identifier }}' -- required
AND ingestion_identifier = '{{ ingestion_identifier }}' -- required
AND ingestion_destination_identifier = '{{ ingestion_destination_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_ingestion_destinations

Returns a list of all ingestion destinations configured for an ingestion.

SELECT
arn
FROM aws.appfabric.ingestion_destinations
WHERE app_bundle_identifier = '{{ app_bundle_identifier }}' -- required
AND ingestion_identifier = '{{ ingestion_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_ingestion_destination

Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

INSERT INTO aws.appfabric.ingestion_destinations (
processingConfiguration,
destinationConfiguration,
clientToken,
tags,
app_bundle_identifier,
ingestion_identifier,
region
)
SELECT 
'{{ processingConfiguration }}' /* required */,
'{{ destinationConfiguration }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ app_bundle_identifier }}',
'{{ ingestion_identifier }}',
'{{ region }}'
RETURNING
ingestion_destination
;

Manifest

# Description fields are for documentation purposes
- name: ingestion_destinations
props:
  - name: app_bundle_identifier
    value: "{{ app_bundle_identifier }}"
    description: Required parameter for the ingestion_destinations resource.
  - name: ingestion_identifier
    value: "{{ ingestion_identifier }}"
    description: Required parameter for the ingestion_destinations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ingestion_destinations resource.
  - name: processingConfiguration
    description: |
      Contains information about how ingested data is processed.
    value:
      auditLog:
        schema: "{{ schema }}"
        format_: "{{ format_ }}"
  - name: destinationConfiguration
    description: |
      Contains information about the destination of ingested data.
    value:
      auditLog:
        destination:
          s3Bucket:
            bucketName: "{{ bucketName }}"
            prefix: "{{ prefix }}"
          firehoseStream:
            streamName: "{{ streamName }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_ingestion_destination

Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

UPDATE aws.appfabric.ingestion_destinations
SET 
destinationConfiguration = '{{ destinationConfiguration }}'
WHERE 
app_bundle_identifier = '{{ app_bundle_identifier }}' --required
AND ingestion_identifier = '{{ ingestion_identifier }}' --required
AND ingestion_destination_identifier = '{{ ingestion_destination_identifier }}' --required
AND region = '{{ region }}' --required
AND destinationConfiguration = '{{ destinationConfiguration }}' --required
RETURNING
ingestion_destination;

DELETE examples

delete_ingestion_destination

Deletes an ingestion destination. This deletes the association between an ingestion and it's destination. It doesn't delete previously ingested data or the storage destination, such as the Amazon S3 bucket where the data is delivered. If the ingestion destination is deleted while the associated ingestion is enabled, the ingestion will fail and is eventually disabled.

DELETE FROM aws.appfabric.ingestion_destinations
WHERE app_bundle_identifier = '{{ app_bundle_identifier }}' --required
AND ingestion_identifier = '{{ ingestion_identifier }}' --required
AND ingestion_destination_identifier = '{{ ingestion_destination_identifier }}' --required
AND region = '{{ region }}' --required
;