[ aws . kinesisanalyticsv2 ]

add-application-cloud-watch-logging-option

Description

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  add-application-cloud-watch-logging-option
--application-name <value>
[--current-application-version-id <value>]
--cloud-watch-logging-option <value>
[--conditional-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-name (string)

The Kinesis Data Analytics application name.

--current-application-version-id (long)

The version ID of the Kinesis Data Analytics application. You must provide the CurrentApplicationVersionId or the ConditionalToken .You can retrieve the application version ID using DescribeApplication . For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId .

--cloud-watch-logging-option (structure)

Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).

LogStreamARN -> (string)

The ARN of the CloudWatch log to receive application messages.

Shorthand Syntax:

LogStreamARN=string

JSON Syntax:

{
  "LogStreamARN": "string"
}

--conditional-token (string)

A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken . You get the application’s current ConditionalToken using DescribeApplication . For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ApplicationARN -> (string)

The application’s ARN.

ApplicationVersionId -> (long)

The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

CloudWatchLoggingOptionDescriptions -> (list)

The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.

(structure)

Describes the Amazon CloudWatch logging option.

CloudWatchLoggingOptionId -> (string)

The ID of the CloudWatch logging option description.

LogStreamARN -> (string)

The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

RoleARN -> (string)

The IAM ARN of the role to use to send application messages.

Note

Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.