elasticache

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

Index

• func DiffMultiCacheClusters(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleCacheCluster(c *gin.Context, dao db.ReaderDAO)
• func GetCacheCluster(c *gin.Context, dao db.ReaderDAO)
• func GetCacheClustersMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetElastiCacheMetadata(c *gin.Context)
• func ListCacheClusters(c *gin.Context, dao db.ReaderDAO)
• type ListCacheClustersResponse

Functions

func DiffMultiCacheClusters

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

DiffMultiCacheClusters godoc @Summary Diff CacheClusters @Description get a diff of CacheClusters between two points in time @Tags aws elasticache @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/elasticache/cache_clusters [get]

func DiffSingleCacheCluster

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

DiffSingleCacheCluster godoc @Summary Diff CacheCluster @Description get a diff of CacheCluster between two points in time @Tags aws elasticache @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 arn path string true "The arn of the CacheCluster to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/elasticache/cache_clusters/{arn} [get]

func GetCacheCluster

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

GetCacheCluster godoc @Summary Get a specific CacheCluster @Description Get a specific CacheCluster by its ARN @Tags aws elasticache @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param arn path string true "The arn of the CacheCluster 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} elasticache.CacheCluster @Failure 400 @Failure 404 @Router /inventory/aws/elasticache/cache_clusters/{arn} [get]

func GetCacheClustersMetadata

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

GetCacheClustersMetadata godoc @Summary Get CacheClusters Metadata @Description get a list of cache_clusters metadata @Tags aws elasticache @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/elasticache/cache_clusters [get]

func GetElastiCacheMetadata

func GetElastiCacheMetadata(c *gin.Context)

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

func ListCacheClusters

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

ListCacheClusters godoc @Summary List CacheClusters @Description get a list of cache_clusters @Tags aws elasticache @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} ListCacheClustersResponse @Failure 400 @Router /inventory/aws/elasticache/cache_clusters [get]

Types

type ListCacheClustersResponse

type ListCacheClustersResponse struct {
	CacheClusters   []*elasticache.CacheCluster `json:"cache_clusters"`
	PaginationToken *string                     `json:"pagination_token,omitempty"`
}