Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add table aws_scheduler_schedule Closes #2304 #2359

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions aws/plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,7 @@ func Plugin(ctx context.Context) *plugin.Plugin {
"aws_sagemaker_model": tableAwsSageMakerModel(ctx),
"aws_sagemaker_notebook_instance": tableAwsSageMakerNotebookInstance(ctx),
"aws_sagemaker_training_job": tableAwsSageMakerTrainingJob(ctx),
"aws_scheduler_schedule": tableAwsSchedulerSchedule(ctx),
"aws_secretsmanager_secret": tableAwsSecretsManagerSecret(ctx),
"aws_securityhub_action_target": tableAwsSecurityHubActionTarget(ctx),
"aws_securityhub_finding": tableAwsSecurityHubFinding(ctx),
Expand Down
15 changes: 14 additions & 1 deletion aws/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ import (
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3control"
"github.com/aws/aws-sdk-go-v2/service/sagemaker"
"github.com/aws/aws-sdk-go-v2/service/scheduler"
"github.com/aws/aws-sdk-go-v2/service/secretsmanager"
"github.com/aws/aws-sdk-go-v2/service/securityhub"
"github.com/aws/aws-sdk-go-v2/service/securitylake"
Expand Down Expand Up @@ -197,6 +198,7 @@ import (
resourceexplorer2Endpoint "github.com/aws/aws-sdk-go/service/resourceexplorer2"
route53resolverEndpoint "github.com/aws/aws-sdk-go/service/route53resolver"
sagemakerEndpoint "github.com/aws/aws-sdk-go/service/sagemaker"
schedulerEndpoint "github.com/aws/aws-sdk-go/service/scheduler"
securityhubEndpoint "github.com/aws/aws-sdk-go/service/securityhub"
securitylakeEndpoint "github.com/aws/aws-sdk-go/service/securitylake"
serverlessrepoEndpoint "github.com/aws/aws-sdk-go/service/serverlessapplicationrepository"
Expand Down Expand Up @@ -1381,6 +1383,17 @@ func SageMakerClient(ctx context.Context, d *plugin.QueryData) (*sagemaker.Clien
return sagemaker.NewFromConfig(*cfg), nil
}

func SchedulerClient(ctx context.Context, d *plugin.QueryData) (*scheduler.Client, error) {
cfg, err := getClientForQuerySupportedRegion(ctx, d, schedulerEndpoint.EndpointsID)
if err != nil {
return nil, err
}
if cfg == nil {
return nil, nil
}
return scheduler.NewFromConfig(*cfg), nil
}

func SecretsManagerClient(ctx context.Context, d *plugin.QueryData) (*secretsmanager.Client, error) {
cfg, err := getClientForQueryRegion(ctx, d)
if err != nil {
Expand Down Expand Up @@ -1500,7 +1513,7 @@ func ShieldClient(ctx context.Context, d *plugin.QueryData) (*shield.Client, err
if err != nil {
return nil, err
}

if cfg == nil {
return nil, nil
}
Expand Down
241 changes: 241 additions & 0 deletions aws/table_aws_scheduler_schedule.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,241 @@
package aws

import (
"context"

"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/scheduler"
"github.com/aws/aws-sdk-go-v2/service/scheduler/types"

schedulerv1 "github.com/aws/aws-sdk-go/service/scheduler"

"github.com/turbot/steampipe-plugin-sdk/v5/grpc/proto"
"github.com/turbot/steampipe-plugin-sdk/v5/plugin"
"github.com/turbot/steampipe-plugin-sdk/v5/plugin/transform"
)

func tableAwsSchedulerSchedule(_ context.Context) *plugin.Table {
return &plugin.Table{
Name: "aws_scheduler_schedule",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Name: "aws_scheduler_schedule",
Name: "aws_eventbridge_schedule",

Should we use the above table name?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following the Terraform naming convention, it is aws_scheduler_* (reference: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/scheduler_schedule).

Do you think we should rename it?

Description: "AWS EventBridge Scheduler Schedule",
Get: &plugin.GetConfig{
KeyColumns: plugin.AllColumns([]string{"name", "group_name"}),
Hydrate: getAwsSchedulerSchedule,
IgnoreConfig: &plugin.IgnoreConfig{
ShouldIgnoreErrorFunc: shouldIgnoreErrors([]string{"ResourceNotFoundException"}),
},
Tags: map[string]string{"service": "scheduler", "action": "GetSchedule"},
},
List: &plugin.ListConfig{
Hydrate: listAwsSchedulerSchedules,
IgnoreConfig: &plugin.IgnoreConfig{
ShouldIgnoreErrorFunc: shouldIgnoreErrors([]string{"ResourceNotFoundException"}),
},
KeyColumns: []*plugin.KeyColumn{
{Name: "group_name", Require: plugin.Optional},
{Name: "state", Require: plugin.Optional},
},
Tags: map[string]string{"service": "scheduler", "action": "ListSchedules"},
},
GetMatrixItemFunc: SupportedRegionMatrix(schedulerv1.EndpointsID),
Columns: awsRegionalColumns([]*plugin.Column{
{
Name: "name",
Description: "The name of the schedule.",
Type: proto.ColumnType_STRING,
},
{
Name: "arn",
Description: "The Amazon Resource Name (ARN) of the schedule.",
Type: proto.ColumnType_STRING,
},
{
Name: "state",
Description: "Specifies whether the schedule is enabled or disabled.",
Type: proto.ColumnType_STRING,
Transform: transform.FromField("State"),
},
{
Name: "description",
Description: "The description of the schedule.",
Type: proto.ColumnType_STRING,
Hydrate: getAwsSchedulerSchedule,
},
{
Name: "schedule_expression",
Description: "The expression that defines when the schedule runs.",
Type: proto.ColumnType_STRING,
Hydrate: getAwsSchedulerSchedule,
},
{
Name: "schedule_expression_timezone",
Description: "The timezone in which the scheduling expression is evaluated.",
Type: proto.ColumnType_STRING,
Hydrate: getAwsSchedulerSchedule,
},
{
Name: "creation_date",
Description: "The time at which the schedule was created.",
Type: proto.ColumnType_TIMESTAMP,
},
{
Name: "last_modification_date",
Description: "The time at which the schedule was last modified.",
Type: proto.ColumnType_TIMESTAMP,
},
{
Name: "start_date",
Description: "The date, in UTC, after which the schedule can begin invoking its target.",
Type: proto.ColumnType_TIMESTAMP,
Hydrate: getAwsSchedulerSchedule,
},
{
Name: "end_date",
Description: "The date, in UTC, before which the schedule can invoke its target.",
Type: proto.ColumnType_TIMESTAMP,
Hydrate: getAwsSchedulerSchedule,
},
{
Name: "group_name",
Description: "The name of the schedule group associated with this schedule.",
Type: proto.ColumnType_STRING,
},
{
Name: "kms_key_arn",
Description: "The ARN for a customer managed KMS Key used for encryption.",
Type: proto.ColumnType_STRING,
Hydrate: getAwsSchedulerSchedule,
},
{
Name: "action_after_completion",
Description: "Indicates the action that EventBridge Scheduler applies after completion.",
Type: proto.ColumnType_STRING,
Hydrate: getAwsSchedulerSchedule,
Transform: transform.FromField("ActionAfterCompletion"),
},
{
Name: "flexible_time_window",
Description: "Allows you to configure a time window during which the schedule invokes the target.",
Type: proto.ColumnType_JSON,
Hydrate: getAwsSchedulerSchedule,
},
{
Name: "target",
Description: "The schedule target.",
Type: proto.ColumnType_JSON,
Hydrate: getAwsSchedulerSchedule,
},

// Standard columns
{
Name: "title",
Description: resourceInterfaceDescription("title"),
Type: proto.ColumnType_STRING,
Transform: transform.FromField("Name"),
},
{
Name: "akas",
Description: resourceInterfaceDescription("akas"),
Type: proto.ColumnType_JSON,
Transform: transform.FromField("Arn").Transform(transform.EnsureStringArray),
},
}),
}
}

//// LIST FUNCTION

func listAwsSchedulerSchedules(ctx context.Context, d *plugin.QueryData, h *plugin.HydrateData) (interface{}, error) {
// Create session
svc, err := SchedulerClient(ctx, d)
if err != nil {
plugin.Logger(ctx).Error("aws_scheduler_schedule.listAwsSchedulerSchedules", "client_error", err)
return nil, err
}

// Limiting the results
maxLimit := int32(100)
if d.QueryContext.Limit != nil {
limit := int32(*d.QueryContext.Limit)
if limit < maxLimit {
maxLimit = limit
}
}

// Build params
params := &scheduler.ListSchedulesInput{}
if d.EqualsQuals["group_name"] != nil {
params.GroupName = aws.String(d.EqualsQuals["group_name"].GetStringValue())
}
if d.EqualsQuals["state"] != nil {
params.State = types.ScheduleState(d.EqualsQuals["state"].GetStringValue())
}

paginator := scheduler.NewListSchedulesPaginator(svc, params, func(o *scheduler.ListSchedulesPaginatorOptions) {
o.Limit = maxLimit
o.StopOnDuplicateToken = true
})

// Iterate and stream results
for paginator.HasMorePages() {
// apply rate limiting
d.WaitForListRateLimit(ctx)

page, err := paginator.NextPage(ctx)
if err != nil {
plugin.Logger(ctx).Error("aws_scheduler_schedule.listAwsSchedulerSchedules", "api_error", err)
return nil, err
}

for _, schedule := range page.Schedules {
d.StreamListItem(ctx, schedule)

// Context can be cancelled due to manual cancellation or the limit has been hit
if d.RowsRemaining(ctx) == 0 {
return nil, nil
}
}
}

return nil, nil
}

//// GET FUNCTION

func getAwsSchedulerSchedule(ctx context.Context, d *plugin.QueryData, h *plugin.HydrateData) (interface{}, error) {
name := d.EqualsQuals["name"].GetStringValue()
groupName := d.EqualsQuals["group_name"].GetStringValue()

if h.Item != nil {
scheduler := h.Item.(types.ScheduleSummary)
name = *scheduler.Name
groupName = *scheduler.GroupName
}

// Empty Check
if name == "" || groupName == "" {
return nil, nil
}

// Create session
svc, err := SchedulerClient(ctx, d)
if err != nil {
plugin.Logger(ctx).Error("aws_scheduler_schedule.getAwsSchedulerSchedule", "client_error", err)
return nil, err
}

// Build params
params := &scheduler.GetScheduleInput{
Name: aws.String(name),
GroupName: aws.String(groupName),
}

// Call API
result, err := svc.GetSchedule(ctx, params)
if err != nil {
plugin.Logger(ctx).Error("aws_scheduler_schedule.getAwsSchedulerSchedule", "api_error", err)
return nil, err
}

return result, nil
}
Loading
Loading