[ aws . observabilityadmin ]

put-connector-telemetry-manifest

Description

Creates or replaces the telemetry manifest of a connector. The telemetry manifest declares which resources in your cloud provider to collect telemetry from and which telemetry types to collect. To avoid overwriting changes made by another caller, specify ExpectedVersion .

See also: AWS API Documentation

Synopsis

  put-connector-telemetry-manifest
--connector-identifier <value>
--manifest <value>
[--expected-version <value>]
[--client-token <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]
[--cli-error-format <value>]
[--help]

Options

--connector-identifier (string) [required]

The connector. Specify one of the following:

  • The Amazon Resource Name (ARN) of the connector
  • The ID of the connector

Constraints:

  • min: 1
  • max: 1011
  • pattern: ([a-z0-9]+|arn:aws[a-z0-9\-]*:observabilityadmin:[a-z0-9-]+:[0-9]{12}:connector/(azure/)?[a-z0-9]+)

--manifest (structure) [required]

The telemetry manifest.

Source -> (tagged union structure) [required]

The resources to collect telemetry from and the telemetry types to collect.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Azure.

Azure -> (list)

The Azure scope items. Each AzureScopeItem specifies a set of Azure resources and the telemetry types to collect from them. You can specify up to 100 scope items.

Constraints:

  • min: 0
  • max: 100

(structure)

The telemetry types to collect from a set of Azure resources.

TelemetryTypes -> (list) [required]

The telemetry types to collect.

Constraints:

  • min: 1
  • max: 3

(string)

Possible values:

  • ResourceLogs
  • Metrics
  • FlowLogs

Scope -> (structure) [required]

The Azure resources to collect telemetry from.

Subscriptions -> (tagged union structure)

The subscriptions to find resources in: all subscriptions that the connector can read, or a list of subscriptions. Required when you use Regions and ResourceTypes .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: All, Ids.

All -> (structure)

All subscriptions that Azure role-based access control (Azure RBAC) allows the connector to read. Subscriptions that the connector can read later are included automatically.

Ids -> (list)

A list of 1–1000 subscription IDs.

Constraints:

  • min: 1
  • max: 1000

(string)

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Regions -> (list)

The Azure Regions to find resources in. Required when you use Subscriptions and ResourceTypes .

Constraints:

  • min: 1
  • max: 100

(string)

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

ResourceTypes -> (list)

The Azure resource types to find. Required when you use Subscriptions and Regions .

Constraints:

  • min: 1
  • max: 100

(string)

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9]+\.[A-Za-z0-9]+/[A-Za-z0-9/]+

TagFilters -> (list)

Limits the resources found by Subscriptions , Regions , and ResourceTypes to those that have these tags. You can specify up to 50 filters.

Constraints:

  • min: 1
  • max: 50

(structure)

A tag filter. A resource matches only if it has the tag. Filters for different tag keys must all match; for one tag key, any of the values can match.

Key -> (string) [required]

The tag key. Up to 512 characters. The characters < > % & ? / $ { } ‘ “ ` and control characters aren’t allowed.

Constraints:

  • min: 1
  • max: 512
  • pattern: [^<>%&\\?/${}'"`\u0000-\u001F\u007F]+

Values -> (list) [required]

The tag values to match. A resource matches if it has any of these values for the tag key.

Constraints:

  • min: 1
  • max: 50

(string)

Constraints:

  • min: 0
  • max: 256
  • pattern: [^${}'"`\\<>\u0000-\u001F\u007F]*

Resources -> (list)

Specific Azure resources, listed by Azure Region.

Constraints:

  • min: 1
  • max: 100

(structure)

Azure resources in one Azure Region.

Region -> (string) [required]

The Azure Region of the resources, for example eastus . Required because an Azure resource ID doesn’t include the Region.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

ResourceIds -> (list) [required]

The Azure Resource Manager IDs of the resources.

Constraints:

  • min: 1
  • max: 1000

(string)

Constraints:

  • min: 1
  • max: 1024
  • pattern: /[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}(/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/${}'"`\\<>%&?#\s\u0000-\u001F\u007F]+)?/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[A-Za-z0-9.]+/[^/${}'"`\\<>%&?#\s\u0000-\u001F\u007F]+(/[^/${}'"`\\<>%&?#\s\u0000-\u001F\u007F]+)*

Infrastructure -> (tagged union structure)

The choices for the infrastructure that the setup creates in your cloud provider, such as the subscription that contains the Event Hubs and their size. If you omit this value, the setup uses default settings. If an AzureScopeItem collects ResourceLogs , you must specify at least the Azure SubscriptionId .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Azure.

Azure -> (structure)

The choices for the Azure infrastructure that the setup creates.

SubscriptionId -> (string)

The Azure subscription in which the setup creates the Event Hubs namespaces and, for AwsManaged Flow Logs, the Storage Accounts. You must specify this value if an AzureScopeItem collects ResourceLogs , or if you specify EventHubs or AwsManaged Flow Logs.

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

EventHubs -> (list)

The Event Hubs configuration. Specify exactly one entry, which applies to the Event Hubs in every Azure Region. This value applies only if an AzureScopeItem collects ResourceLogs . If you omit it, the setup uses default settings.

Constraints:

  • min: 1
  • max: 1

(structure)

Configuration of the Azure Event Hubs that the setup creates to deliver resource logs.

Tier -> (string) [required]

The Event Hubs namespace tier.

Possible values:

  • Standard
  • Premium

PartitionCount -> (integer) [required]

The number of partitions in each Event Hub. The Standard tier allows 1–32 partitions and the Premium tier allows 1–100. On the Standard tier, you can’t change this value after the setup creates the Event Hub.

Constraints:

  • min: 1
  • max: 100

FlowLogs -> (tagged union structure)

The location of your Flow Logs. You must specify this value if an AzureScopeItem collects FlowLogs , and you can specify it only in that case.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: CustomerManaged, AwsManaged.

CustomerManaged -> (structure)

Use your existing Storage Accounts that already store Flow Logs.

StorageAccounts -> (list) [required]

The Storage Accounts that store your Flow Logs, listed by Azure Region. Each Region can appear only once, and each Storage Account can appear only once across all Regions.

Constraints:

  • min: 1
  • max: 100

(structure)

The Azure Storage Accounts in one Azure Region that store Flow Logs.

Region -> (string) [required]

The Azure Region of the Storage Accounts, for example eastus .

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

StorageAccountIds -> (list) [required]

The Azure Resource Manager IDs of the Storage Accounts.

Constraints:

  • min: 1
  • max: 100

(string)

Constraints:

  • min: 1
  • max: 1024
  • pattern: /[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/${}'"`\\<>%&?#\s\u0000-\u001F\u007F]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[sS][tT][oO][rR][aA][gG][eE]/[sS][tT][oO][rR][aA][gG][eE][aA][cC][cC][oO][uU][nN][tT][sS]/[a-z0-9]{3,24}

AwsManaged -> (structure)

Create one Storage Account in each Azure Region that ingests Flow Logs, in the subscription specified by SubscriptionId .

RetentionDays -> (integer) [required]

The number of days that the created Storage Accounts keep Flow Logs.

Constraints:

  • min: 1
  • max: 365

JSON Syntax:

{
  "Source": {
    "Azure": [
      {
        "TelemetryTypes": ["ResourceLogs"|"Metrics"|"FlowLogs", ...],
        "Scope": {
          "Subscriptions": {
            "All": {

            },
            "Ids": ["string", ...]
          },
          "Regions": ["string", ...],
          "ResourceTypes": ["string", ...],
          "TagFilters": [
            {
              "Key": "string",
              "Values": ["string", ...]
            }
            ...
          ],
          "Resources": [
            {
              "Region": "string",
              "ResourceIds": ["string", ...]
            }
            ...
          ]
        }
      }
      ...
    ]
  },
  "Infrastructure": {
    "Azure": {
      "SubscriptionId": "string",
      "EventHubs": [
        {
          "Tier": "Standard"|"Premium",
          "PartitionCount": integer
        }
        ...
      ],
      "FlowLogs": {
        "CustomerManaged": {
          "StorageAccounts": [
            {
              "Region": "string",
              "StorageAccountIds": ["string", ...]
            }
            ...
          ]
        },
        "AwsManaged": {
          "RetentionDays": integer
        }
      }
    }
  }
}

--expected-version (long)

The version of the telemetry manifest that you expect to replace, as returned by GetConnectorTelemetryManifest . Omit this value when you create the first telemetry manifest. If the value doesn’t match the current version, the request fails with a ConflictException .

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If you use an Amazon Web Services SDK, the SDK generates this value and reuses it on retries. If this token matches a previous request with the same telemetry manifest, the service returns the stored version without an error. If you use the same token with a different telemetry manifest, the service returns a ValidationException . This operation is idempotent when you use the same token and parameters.

Constraints:

  • min: 1
  • max: 64
  • pattern: [!-~]+

--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
  • off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

Version -> (long)

The version of the telemetry manifest after this update.