cloudproviderapi

Documentation

Index

• type AWSAccount
• type AWSCloudWatchCustomNamespace
• type AWSCloudWatchMetric
• type AWSCloudWatchScrapeJobRequest
• type AWSCloudWatchScrapeJobResponse
• type AWSCloudWatchService
• type AWSCloudWatchTagFilter
• type AzureCredential
• type Client
  • func NewClient(authToken string, rawAPIURL string, client *http.Client, ...) (*Client, error)
  • func (c *Client) CreateAWSAccount(ctx context.Context, stackID string, accountData AWSAccount) (AWSAccount, error)
  • func (c *Client) CreateAWSCloudWatchScrapeJob(ctx context.Context, stackID string, jobData AWSCloudWatchScrapeJobRequest) (AWSCloudWatchScrapeJobResponse, error)
  • func (c *Client) CreateAzureCredential(ctx context.Context, stackID string, credentialData AzureCredential) (AzureCredential, error)
  • func (c *Client) DeleteAWSAccount(ctx context.Context, stackID string, accountID string) error
  • func (c *Client) DeleteAWSCloudWatchScrapeJob(ctx context.Context, stackID string, jobName string) error
  • func (c *Client) DeleteAzureCredential(ctx context.Context, stackID string, credentialID string) error
  • func (c *Client) GetAWSAccount(ctx context.Context, stackID string, accountID string) (AWSAccount, error)
  • func (c *Client) GetAWSCloudWatchScrapeJob(ctx context.Context, stackID string, jobName string) (AWSCloudWatchScrapeJobResponse, error)
  • func (c *Client) GetAzureCredential(ctx context.Context, stackID string, credentialID string) (AzureCredential, error)
  • func (c *Client) ListAWSCloudWatchScrapeJobs(ctx context.Context, stackID string) ([]AWSCloudWatchScrapeJobResponse, error)
  • func (c *Client) UpdateAWSAccount(ctx context.Context, stackID string, accountID string, accountData AWSAccount) (AWSAccount, error)
  • func (c *Client) UpdateAWSCloudWatchScrapeJob(ctx context.Context, stackID string, jobName string, ...) (AWSCloudWatchScrapeJobResponse, error)
  • func (c *Client) UpdateAzureCredential(ctx context.Context, stackID string, accountID string, ...) (AzureCredential, error)
• type TagFilter

Types

type AWSAccount

type AWSAccount struct {
	// ID is the unique identifier for the AWS account in our systems.
	ID string `json:"id"`

	// RoleARN is the AWS ARN of the associated IAM role granting Grafana access to the AWS Account.
	RoleARN string `json:"role_arn"`

	// Regions is the list of AWS regions in use for the AWS Account.
	Regions []string `json:"regions"`
}

type AWSCloudWatchCustomNamespace

type AWSCloudWatchCustomNamespace struct {
	Name                  string                `json:"name"`
	Metrics               []AWSCloudWatchMetric `json:"metrics"`
	ScrapeIntervalSeconds int64                 `json:"scrapeIntervalSeconds"`
}

type AWSCloudWatchMetric

type AWSCloudWatchMetric struct {
	Name       string   `json:"name"`
	Statistics []string `json:"statistics"`
}

type AWSCloudWatchScrapeJobRequest

type AWSCloudWatchScrapeJobRequest struct {
	Name                  string                         `json:"name"`
	Enabled               bool                           `json:"enabled"`
	AWSAccountResourceID  string                         `json:"awsAccountResourceID"`
	RegionsSubsetOverride []string                       `json:"regionsSubsetOverride"`
	ExportTags            bool                           `json:"exportTags"`
	Services              []AWSCloudWatchService         `json:"services"`
	CustomNamespaces      []AWSCloudWatchCustomNamespace `json:"customNamespaces"`
}

type AWSCloudWatchScrapeJobResponse

type AWSCloudWatchScrapeJobResponse struct {
	Name                 string                         `json:"name"`
	Enabled              bool                           `json:"enabled"`
	AWSAccountResourceID string                         `json:"awsAccountResourceID"`
	ExportTags           bool                           `json:"exportTags"`
	Services             []AWSCloudWatchService         `json:"services"`
	CustomNamespaces     []AWSCloudWatchCustomNamespace `json:"customNamespaces"`
	// computed fields beyond the original request
	RoleARN                   string   `json:"roleARN"`
	Regions                   []string `json:"regions"`
	RegionsSubsetOverrideUsed bool     `json:"regionsSubsetOverrideUsed"`
	DisabledReason            string   `json:"disabledReason"`
	Provenance                string   `json:"provenance"`
}

type AWSCloudWatchService

type AWSCloudWatchService struct {
	Name                        string                   `json:"name"`
	Metrics                     []AWSCloudWatchMetric    `json:"metrics"`
	ScrapeIntervalSeconds       int64                    `json:"scrapeIntervalSeconds"`
	ResourceDiscoveryTagFilters []AWSCloudWatchTagFilter `json:"resourceDiscoveryTagFilters"`
	TagsToAddToMetrics          []string                 `json:"tagsToAddToMetrics"`
}

type AWSCloudWatchTagFilter

type AWSCloudWatchTagFilter struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type AzureCredential

type AzureCredential struct {
	// ID is the unique identifier for the Azure credential in our systems.
	ID string `json:"id"`

	// Name is the user-defined name for the Azure credential.
	Name string `json:"name"`

	// TenantID is the Azure tenant ID.
	TenantID string `json:"tenant_id"`

	// ClientID is the Azure client ID.
	ClientID string `json:"client_id"`

	// ClientSecret is the Azure client secret.
	ClientSecret string `json:"client_secret"`

	// StackID is the unique identifier for the stack in our systems.
	StackID string `json:"stack_id"`

	// ResourceTagFilters is the list of Azure resource tag filters.
	ResourceTagFilters []TagFilter `json:"resource_tag_filters"`
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(authToken string, rawAPIURL string, client *http.Client, defaultHeaders map[string]string) (*Client, error)

func (*Client) CreateAWSAccount

func (c *Client) CreateAWSAccount(ctx context.Context, stackID string, accountData AWSAccount) (AWSAccount, error)

func (*Client) CreateAWSCloudWatchScrapeJob

func (c *Client) CreateAWSCloudWatchScrapeJob(ctx context.Context, stackID string, jobData AWSCloudWatchScrapeJobRequest) (AWSCloudWatchScrapeJobResponse, error)

func (*Client) CreateAzureCredential

func (c *Client) CreateAzureCredential(ctx context.Context, stackID string, credentialData AzureCredential) (AzureCredential, error)

func (*Client) DeleteAWSAccount

func (c *Client) DeleteAWSAccount(ctx context.Context, stackID string, accountID string) error

func (*Client) DeleteAWSCloudWatchScrapeJob

func (c *Client) DeleteAWSCloudWatchScrapeJob(ctx context.Context, stackID string, jobName string) error

func (*Client) DeleteAzureCredential

func (c *Client) DeleteAzureCredential(ctx context.Context, stackID string, credentialID string) error

func (*Client) GetAWSAccount

func (c *Client) GetAWSAccount(ctx context.Context, stackID string, accountID string) (AWSAccount, error)

func (*Client) GetAWSCloudWatchScrapeJob

func (c *Client) GetAWSCloudWatchScrapeJob(ctx context.Context, stackID string, jobName string) (AWSCloudWatchScrapeJobResponse, error)

func (*Client) GetAzureCredential

func (c *Client) GetAzureCredential(ctx context.Context, stackID string, credentialID string) (AzureCredential, error)

func (*Client) ListAWSCloudWatchScrapeJobs

func (c *Client) ListAWSCloudWatchScrapeJobs(ctx context.Context, stackID string) ([]AWSCloudWatchScrapeJobResponse, error)

func (*Client) UpdateAWSAccount

func (c *Client) UpdateAWSAccount(ctx context.Context, stackID string, accountID string, accountData AWSAccount) (AWSAccount, error)

func (*Client) UpdateAWSCloudWatchScrapeJob

func (c *Client) UpdateAWSCloudWatchScrapeJob(ctx context.Context, stackID string, jobName string, jobData AWSCloudWatchScrapeJobRequest) (AWSCloudWatchScrapeJobResponse, error)

func (*Client) UpdateAzureCredential

func (c *Client) UpdateAzureCredential(ctx context.Context, stackID string, accountID string, credentialData AzureCredential) (AzureCredential, error)

type TagFilter

type TagFilter struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}