[ aws . observabilityadmin ]

update-telemetry-rule

Description

Updates an existing telemetry rule in your account.

See also: AWS API Documentation

Synopsis

  update-telemetry-rule
--rule-identifier <value>
--rule <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--rule-identifier (string)

The identifier (name or ARN) of the telemetry rule to update.

--rule (structure)

The new configuration details for the telemetry rule.

ResourceType -> (string)

The type of Amazon Web Services resource to configure telemetry for (e.g., “AWS::EC2::VPC”).

TelemetryType -> (string)

The type of telemetry to collect (Logs, Metrics, or Traces).

DestinationConfiguration -> (structure)

Configuration specifying where and how the telemetry data should be delivered.

DestinationType -> (string)

The type of destination for the telemetry data (e.g., “Amazon CloudWatch Logs”, “S3”).

DestinationPattern -> (string)

The pattern used to generate the destination path or name, supporting macros like <resourceId> and <accountId>.

RetentionInDays -> (integer)

The number of days to retain the telemetry data in the destination.

VPCFlowLogParameters -> (structure)

Configuration parameters specific to VPC Flow Logs when VPC is the resource type.

LogFormat -> (string)

The format in which VPC Flow Log entries should be logged.

TrafficType -> (string)

The type of traffic to log (ACCEPT, REJECT, or ALL).

MaxAggregationInterval -> (integer)

The maximum interval in seconds between the capture of flow log records.

Scope -> (string)

The organizational scope to which the rule applies, specified using accounts or organizational units.

SelectionCriteria -> (string)

Criteria for selecting which resources the rule applies to, such as resource tags.

Shorthand Syntax:

ResourceType=string,TelemetryType=string,DestinationConfiguration={DestinationType=string,DestinationPattern=string,RetentionInDays=integer,VPCFlowLogParameters={LogFormat=string,TrafficType=string,MaxAggregationInterval=integer}},Scope=string,SelectionCriteria=string

JSON Syntax:

{
  "ResourceType": "AWS::EC2::Instance"|"AWS::EC2::VPC"|"AWS::Lambda::Function",
  "TelemetryType": "Logs"|"Metrics"|"Traces",
  "DestinationConfiguration": {
    "DestinationType": "cloud-watch-logs",
    "DestinationPattern": "string",
    "RetentionInDays": integer,
    "VPCFlowLogParameters": {
      "LogFormat": "string",
      "TrafficType": "string",
      "MaxAggregationInterval": integer
    }
  },
  "Scope": "string",
  "SelectionCriteria": "string"
}

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

RuleArn -> (string)

The Amazon Resource Name (ARN) of the updated telemetry rule.