application_snapshots

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

Overview

Name	application_snapshots
Type	Resource
Id	aws.kinesisanalyticsv2.application_snapshots

Fields

The following fields are returned by SELECT queries:

describe_application_snapshot

Name	Datatype	Description
application_encryption_configuration_description	object	Specifies the encryption settings of data at rest for the application snapshot.
application_version_id	integer (int64)	The current application version ID when the snapshot was created.
runtime_environment	string	The Flink Runtime for the application snapshot. (SQL-1_0, FLINK-1_6, FLINK-1_8, ZEPPELIN-FLINK-1_0, FLINK-1_11, FLINK-1_13, ZEPPELIN-FLINK-2_0, FLINK-1_15, ZEPPELIN-FLINK-3_0, FLINK-1_18, FLINK-1_19, FLINK-1_20, FLINK-2_2, FLINK-2_3)
snapshot_creation_timestamp	string (date-time)	The timestamp of the application snapshot.
snapshot_name	string	The identifier for the application snapshot. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
snapshot_status	string	The status of the application snapshot. (CREATING, READY, DELETING, FAILED)

list_application_snapshots

Name	Datatype	Description
application_encryption_configuration_description	object	Specifies the encryption settings of data at rest for the application snapshot.
application_version_id	integer (int64)	The current application version ID when the snapshot was created.
runtime_environment	string	The Flink Runtime for the application snapshot. (SQL-1_0, FLINK-1_6, FLINK-1_8, ZEPPELIN-FLINK-1_0, FLINK-1_11, FLINK-1_13, ZEPPELIN-FLINK-2_0, FLINK-1_15, ZEPPELIN-FLINK-3_0, FLINK-1_18, FLINK-1_19, FLINK-1_20, FLINK-2_2, FLINK-2_3)
snapshot_creation_timestamp	string (date-time)	The timestamp of the application snapshot.
snapshot_name	string	The identifier for the application snapshot. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
snapshot_status	string	The status of the application snapshot. (CREATING, READY, DELETING, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_application_snapshot	select	region		Returns information about a snapshot of application state data.
list_application_snapshots	select	region		Lists information about the current application snapshots.
create_application_snapshot	insert	region, ApplicationName, SnapshotName		Creates a snapshot of the application's state data.
delete_application_snapshot	delete	region		Deletes a snapshot of application state.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_application_snapshot

Returns information about a snapshot of application state data.

SELECT
application_encryption_configuration_description,
application_version_id,
runtime_environment,
snapshot_creation_timestamp,
snapshot_name,
snapshot_status
FROM aws.kinesisanalyticsv2.application_snapshots
WHERE region = '{{ region }}' -- required
;

list_application_snapshots

Lists information about the current application snapshots.

SELECT
application_encryption_configuration_description,
application_version_id,
runtime_environment,
snapshot_creation_timestamp,
snapshot_name,
snapshot_status
FROM aws.kinesisanalyticsv2.application_snapshots
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_application_snapshot

Creates a snapshot of the application's state data.

INSERT INTO aws.kinesisanalyticsv2.application_snapshots (
ApplicationName,
SnapshotName,
region
)
SELECT 
'{{ ApplicationName }}' /* required */,
'{{ SnapshotName }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: application_snapshots
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the application_snapshots resource.
  - name: ApplicationName
    value: "{{ ApplicationName }}"
    description: |
      The name of an existing application
  - name: SnapshotName
    value: "{{ SnapshotName }}"
    description: |
      An identifier for the application snapshot.

DELETE examples

delete_application_snapshot

Deletes a snapshot of application state.

DELETE FROM aws.kinesisanalyticsv2.application_snapshots
WHERE region = '{{ region }}' --required
;