cloudwatchobservabilityaccessmanager: CloudWatch Observability Access Manager

In paws.management: 'Amazon Web Services' Management & Governance Services

CloudWatch Observability Access Manager

Description

Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.

Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.

Usage

cloudwatchobservabilityaccessmanager(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- cloudwatchobservabilityaccessmanager(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_link	Creates a link between a source account and a sink that you have created in a monitoring account
create_sink	Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability
delete_link	Deletes a link between a monitoring account sink and a source account
delete_sink	Deletes a sink
get_link	Returns complete information about one link
get_sink	Returns complete information about one monitoring account sink
get_sink_policy	Returns the current sink policy attached to this sink
list_attached_links	Returns a list of source account links that are linked to this monitoring account sink
list_links	Use this operation in a source account to return a list of links to monitoring account sinks that this source account has
list_sinks	Use this operation in a monitoring account to return the list of sinks created in that account
list_tags_for_resource	Displays the tags associated with a resource
put_sink_policy	Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink
tag_resource	Assigns one or more tags (key-value pairs) to the specified resource
untag_resource	Removes one or more tags from the specified resource
update_link	Use this operation to change what types of data are shared from a source account to its linked monitoring account sink

Examples

## Not run: 
svc <- cloudwatchobservabilityaccessmanager()
svc$create_link(
  Foo = 123
)

## End(Not run)

paws.management documentation built on Sept. 12, 2024, 6:19 a.m.