Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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

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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--application-name (string)

The Kinesis Data Analytics application name.

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

The version ID of the SQL-based 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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ApplicationARN -> (string)

The application's ARN.

ApplicationVersionId -> (long)

The new version ID of the SQL-based 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 SQL-based 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.

OperationId -> (string)

Operation ID for tracking AddApplicationCloudWatchLoggingOption request