app_bundles

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

Overview

Name	app_bundles
Type	Resource
Id	aws.appfabric.app_bundles

Fields

The following fields are returned by SELECT queries:

get_app_bundle

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the app bundle. (pattern: <code>arn:.+</code>)
customer_managed_key_arn	string	The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the application data. (pattern: <code>arn:.+</code>)

list_app_bundles

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_app_bundle	select	app_bundle_identifier, region		Returns information about an app bundle.
list_app_bundles	select	region	maxResults, nextToken	Returns a list of app bundles.
create_app_bundle	insert	region		Creates an app bundle to collect data from an application using AppFabric.
delete_app_bundle	delete	app_bundle_identifier, region		Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.
start_ingestion	exec	ingestion_identifier, app_bundle_identifier, region		Starts (enables) an ingestion, which collects data from an application.
stop_ingestion	exec	ingestion_identifier, app_bundle_identifier, region		Stops (disables) an ingestion.

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_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_app_bundle

Returns information about an app bundle.

SELECT
arn,
customer_managed_key_arn
FROM aws.appfabric.app_bundles
WHERE app_bundle_identifier = '{{ app_bundle_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_app_bundles

Returns a list of app bundles.

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

INSERT examples

create_app_bundle

Creates an app bundle to collect data from an application using AppFabric.

INSERT INTO aws.appfabric.app_bundles (
clientToken,
customerManagedKeyIdentifier,
tags,
region
)
SELECT 
'{{ clientToken }}',
'{{ customerManagedKeyIdentifier }}',
'{{ tags }}',
'{{ region }}'
RETURNING
app_bundle
;

Manifest

# Description fields are for documentation purposes
- name: app_bundles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_bundles resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: customerManagedKeyIdentifier
    value: "{{ customerManagedKeyIdentifier }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

DELETE examples

delete_app_bundle

Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.

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

Lifecycle Methods

start_ingestion

Starts (enables) an ingestion, which collects data from an application.

EXEC aws.appfabric.app_bundles.start_ingestion 
@ingestion_identifier='{{ ingestion_identifier }}' --required, 
@app_bundle_identifier='{{ app_bundle_identifier }}' --required, 
@region='{{ region }}' --required
;

stop_ingestion

Stops (disables) an ingestion.

EXEC aws.appfabric.app_bundles.stop_ingestion 
@ingestion_identifier='{{ ingestion_identifier }}' --required, 
@app_bundle_identifier='{{ app_bundle_identifier }}' --required, 
@region='{{ region }}' --required
;