rds

Documentation

Overview

AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_api_routes.tmpl

AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_api_routes.tmpl

AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_service_metadata_route.tmpl

Index

• func DiffMultiDBClusters(c *gin.Context, dao db.ReaderDAO)
• func DiffMultiDBInstances(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleDBCluster(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleDBInstance(c *gin.Context, dao db.ReaderDAO)
• func GetDBCluster(c *gin.Context, dao db.ReaderDAO)
• func GetDBClustersMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetDBInstance(c *gin.Context, dao db.ReaderDAO)
• func GetDBInstancesMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetRDSMetadata(c *gin.Context)
• func ListDBClusters(c *gin.Context, dao db.ReaderDAO)
• func ListDBInstances(c *gin.Context, dao db.ReaderDAO)
• type ListDBClustersResponse
• type ListDBInstancesResponse

Functions

func DiffMultiDBClusters

func DiffMultiDBClusters(c *gin.Context, dao db.ReaderDAO)

DiffMultiDBClusters godoc @Summary Diff DBClusters @Description get a diff of DBClusters between two points in time @Tags aws rds @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/rds/db_clusters [get]

func DiffMultiDBInstances

func DiffMultiDBInstances(c *gin.Context, dao db.ReaderDAO)

DiffMultiDBInstances godoc @Summary Diff DBInstances @Description get a diff of DBInstances between two points in time @Tags aws rds @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/rds/db_instances [get]

func DiffSingleDBCluster

func DiffSingleDBCluster(c *gin.Context, dao db.ReaderDAO)

DiffSingleDBCluster godoc @Summary Diff DBCluster @Description get a diff of DBCluster between two points in time @Tags aws rds @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param db_cluster_arn path string true "The db_cluster_arn of the DBCluster to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/rds/db_clusters/{db_cluster_arn} [get]

func DiffSingleDBInstance

func DiffSingleDBInstance(c *gin.Context, dao db.ReaderDAO)

DiffSingleDBInstance godoc @Summary Diff DBInstance @Description get a diff of DBInstance between two points in time @Tags aws rds @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param db_instance_arn path string true "The db_instance_arn of the DBInstance to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/rds/db_instances/{db_instance_arn} [get]

func GetDBCluster

func GetDBCluster(c *gin.Context, dao db.ReaderDAO)

GetDBCluster godoc @Summary Get a specific DBCluster @Description Get a specific DBCluster by its DBClusterArn @Tags aws rds @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param db_cluster_arn path string true "The db_cluster_arn of the DBCluster to retrieve" @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Security ApiKeyAuth @Success 200 {object} rds.DBCluster @Failure 400 @Failure 404 @Router /inventory/aws/rds/db_clusters/{db_cluster_arn} [get]

func GetDBClustersMetadata

func GetDBClustersMetadata(c *gin.Context, dao db.ReaderDAO)

GetDBClustersMetadata godoc @Summary Get DBClusters Metadata @Description get a list of db_clusters metadata @Tags aws rds @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Security ApiKeyAuth @Success 200 {array} routes.AwsResourceMetadata @Failure 400 @Router /metadata/aws/rds/db_clusters [get]

func GetDBInstance

func GetDBInstance(c *gin.Context, dao db.ReaderDAO)

GetDBInstance godoc @Summary Get a specific DBInstance @Description Get a specific DBInstance by its DBInstanceArn @Tags aws rds @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param db_instance_arn path string true "The db_instance_arn of the DBInstance to retrieve" @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Security ApiKeyAuth @Success 200 {object} rds.DBInstance @Failure 400 @Failure 404 @Router /inventory/aws/rds/db_instances/{db_instance_arn} [get]

func GetDBInstancesMetadata

func GetDBInstancesMetadata(c *gin.Context, dao db.ReaderDAO)

GetDBInstancesMetadata godoc @Summary Get DBInstances Metadata @Description get a list of db_instances metadata @Tags aws rds @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Security ApiKeyAuth @Success 200 {array} routes.AwsResourceMetadata @Failure 400 @Router /metadata/aws/rds/db_instances [get]

func GetRDSMetadata

func GetRDSMetadata(c *gin.Context)

GetRDSMetadata godoc @Summary Get RDS Metadata @Description get a list of RDS metadata @Tags aws rds @Produce json @Security ApiKeyAuth @Success 200 {array} routes.AwsServiceMetadata @Failure 400 @Router /metadata/aws/rds [get]

func ListDBClusters

func ListDBClusters(c *gin.Context, dao db.ReaderDAO)

ListDBClusters godoc @Summary List DBClusters @Description get a list of db_clusters @Tags aws rds @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param pagination_token query string false "A pagination token. If this is specified, the next set of results is retrieved. The pagination token is returned in the response." @Param max_results query int false "The maximum number of results to return. Default is 100" @Security ApiKeyAuth @Success 200 {object} ListDBClustersResponse @Failure 400 @Router /inventory/aws/rds/db_clusters [get]

func ListDBInstances

func ListDBInstances(c *gin.Context, dao db.ReaderDAO)

ListDBInstances godoc @Summary List DBInstances @Description get a list of db_instances @Tags aws rds @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param pagination_token query string false "A pagination token. If this is specified, the next set of results is retrieved. The pagination token is returned in the response." @Param max_results query int false "The maximum number of results to return. Default is 100" @Security ApiKeyAuth @Success 200 {object} ListDBInstancesResponse @Failure 400 @Router /inventory/aws/rds/db_instances [get]

Types

type ListDBClustersResponse

type ListDBClustersResponse struct {
	DBClusters      []*rds.DBCluster `json:"db_clusters"`
	PaginationToken *string          `json:"pagination_token,omitempty"`
}

type ListDBInstancesResponse

type ListDBInstancesResponse struct {
	DBInstances     []*rds.DBInstance `json:"db_instances"`
	PaginationToken *string           `json:"pagination_token,omitempty"`
}