package aws

Import Path
	contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	      aws_identity_doc_utils.go
	      monitored_resources.go
Package-Level Type Names (total 3, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type EC2Instance (struct)
		EC2Instance represents aws_ec2_instance type monitored resource.
		For definition refer to
		https://cloud.google.com/monitoring/api/resources#tag_aws_ec2_instance

		Fields (total 3, all are exported)
			AWSAccount string
				AWSAccount is the AWS account number for the VM.

			InstanceID string
				InstanceID is the instance id of the instance.

			Region string
				Region is the AWS region for the VM. The format of this field is "aws:{region}",
				where supported values for {region} are listed at
				http://docs.aws.amazon.com/general/latest/gr/rande.html.

		Methods (only one, which is exported)
			(*T) MonitoredResource() (resType string, labels map[string]string)
				MonitoredResource returns resource type and resource labels for AWSEC2Instance

		Implements (at least 3, all are exported)
			*T : Interface
			*T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.Interface
			*T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.Interface
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func createEC2InstanceMonitoredResource(awsIdentityDoc *awsIdentityDocument) *EC2Instance

	 type Interface (interface)
		Interface is a type that represent monitor resource that satisfies monitoredresource.Interface

		Methods (only one, which is exported)
			( T) MonitoredResource() (resType string, labels map[string]string)
				MonitoredResource returns the resource type and resource labels.

		Implemented By (at least 9, in which 8 are exported)
			*EC2Instance
			*contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.AWSEC2Instance
			*contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.GCEInstance
			*contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.GKEContainer
			 contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.Interface (interface)
			*contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.GCEInstance
			*contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.GKEContainer
			 contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.Interface (interface)
			/* at least one unexported ... *//* at least one unexported: */
			*golang.org/x/pkgsite/internal/dcensus.monitoredResource
		Implements (at least 2, both are exported)
			 T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.Interface
			 T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.Interface
		As Outputs Of (at least 2, in which 1 are exported)
			func Autodetect() Interface
			/* at least one unexported ... *//* at least one unexported: */
			func detectResourceType(awsIdentityDoc *awsIdentityDocument) Interface
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var autoDetected

	/* one unexported ... *//* one unexported: */
	 type awsIdentityDocument (struct)
		awsIdentityDocument is used to store parsed AWS Identity Document.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			accountID string
				accountID is the AWS account number for the VM.

			instanceID string
				instanceID is the instance id of the instance.

			region string
				Region is the AWS region for the VM.

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func retrieveAWSIdentityDocument() *awsIdentityDocument
		As Inputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func createEC2InstanceMonitoredResource(awsIdentityDoc *awsIdentityDocument) *EC2Instance
			func detectResourceType(awsIdentityDoc *awsIdentityDocument) Interface


Package-Level Functions (total 4, in which 1 are exported)

	 func Autodetect() Interface
		Autodetect auto detects monitored resources based on
		the environment where the application is running.
		It supports detection of following resource types
		1. aws_ec2_instance:

		Returns MonitoredResInterface which implements getLabels() and getType()
		For resource definition go to https://cloud.google.com/monitoring/api/resources

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func createEC2InstanceMonitoredResource(awsIdentityDoc *awsIdentityDocument) *EC2Instance
		createAWSEC2InstanceMonitoredResource creates a aws_ec2_instance monitored resource
		awsIdentityDoc contains AWS EC2 specific attributes.

	 func detectResourceType(awsIdentityDoc *awsIdentityDocument) Interface
		detectResourceType determines the resource type.
		awsIdentityDoc contains AWS EC2 attributes. nil if it is not AWS EC2 environment

	 func retrieveAWSIdentityDocument() *awsIdentityDocument
		retrieveAWSIdentityDocument attempts to retrieve AWS Identity Document.
		If the environment is AWS EC2 Instance then a valid document is retrieved.
		Relevant attributes from the document are stored in awsIdentityDoc.
		This is only done once.


Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var autoDetected Interface
		autoDetected is the metadata detected after the first execution of Autodetect function.

	  var detectOnce sync.Once
		detectOnce is used to make sure AWS metadata detect function executes only once.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.