Skeddly API
  • Introduction
  • Overview
    • Making Requests
    • Authentication
    • Clients
    • Errors
      • HTTP Status Codes
      • Error Codes
      • Handling Errors
  • Resources
    • Action Exclusions
      • CreateActionExclusion Method
      • DeleteActionExclusion Method
      • GetActionExclusion Method
      • ListActionExclusions Method
      • ModifyActionExclusion Method
    • Action Executions
      • CancelActionExecution Method
      • GetActionExecution Method
      • GetActionExecutionLog Method
      • ListActionExecutions Method
      • ListUpcomingActionExecutions Method
    • Actions
      • Action Types
      • CreateAction Method
      • DeleteAction Method
      • ExecuteAction Method
      • GetAction Method
      • ListActions Method
      • ModifyAction Method
    • Credentials
      • CreateCredential Method
      • CopyCredential Method
      • DeleteCredential Method
      • GenerateIamPolicy Method
      • GenerateAmazonIamRoleExternalId Method
      • GetCredential Method
      • ListCredentials Method
      • ModifyCredential Method
    • Managed Policies
      • GetManagedPolicy Method
      • ListManagedPolicies Method
    • Managed Services
      • CreateManagedServicesPlan Method
      • CreateManagedServicesSelector Method
      • DeleteManagedServicesPlan Method
      • DeleteManagedServicesSelector Method
      • GetManagedServicesPlan Method
      • GetManagedServicesSelector Method
      • ListManagedServicesPlans Method
      • ListManagedServicesSelectors Method
      • ModifyManagedServicesPlan Method
      • ModifyManagedServicesSelector Method
    • Projects
      • ArchiveProject Method
      • CreateProject Method
      • CreateProjectNotification Method
      • CreateProjectRss Method
      • DeleteProjectNotification Method
      • GetProject Method
      • ListProjects Method
      • ModifyProject Method
      • ModifyProjectAccountNotifications Method
      • ModifyProjectReportEmails Method
    • Reports
      • GetBackupsReport Method
    • Regions
      • GetRegion Method
      • ListRegions Method
    • Time Zones
      • ListTimeZones Method
    • Users
      • AttachManagedPolicy Method
      • CreateUser Method
      • DeleteUser Method
      • DetachManagedPolicy Method
      • GetUser Method
      • ListUsers Method
      • ModifyUser Method
      • ModifyUserPassword Method
      • RemoveUserMfa Method
  • Data Types
    • Action Object
    • ActionExecution Object
    • ActionExecutionResult Object
    • ActionExecutionTrigger Object
    • ActionExclusion Object
    • ActionParameters Object
      • AmazonAddSecurityGroupRuleParameters Object
      • AmazonApplyS3BucketPolicyParameters Object
      • AmazonAssociateElasticIpParameters Object
      • AmazonAttachIamRoleToEc2InstancesParameters Object
      • AmazonBackupEc2InstanceParameters Object
      • AmazonBackupEc2InstancesParameters Object
      • AmazonBackupMySQLServerParameters Object
      • AmazonBackupRoute53HostedZoneParameters Object
      • AmazonBackupRoute53HostedZonesParameters Object
      • AmazonChangeDynamoDbTablesParameters Object
      • AmazonChangeEbsVolumesParameters Object
      • AmazonChangeEc2InstanceTypeParameters Object
      • AmazonChangeEc2InstancesParameters Object
      • AmazonChangeRdsInstanceClassParameters Object
      • AmazonCheckRootAccessKeysParameters Object
      • AmazonCloudFormationStackDriftReportParameters Object
      • AmazonCopyAmiImagesParameters Object
      • AmazonCopyEbsSnapshotsParameters Object
      • AmazonCopyEbsVolumeParameters Object
      • AmazonCopyEc2InstanceParameters Object
      • AmazonCopyRdsSnapshotsParameters Object
      • AmazonCopyS3ObjectsParameters Object
      • AmazonCreateAmiImageParameters Object
      • AmazonCreateAmiImagesParameters Object
      • AmazonCreateCloudFormationStackParameters Object
      • AmazonCreateCloudTrailTrailsParameters Object
      • AmazonCreateDirectoryServiceSnapshotsParameters Object
      • AmazonCreateDynamoDbBackupsParameters Object
      • AmazonCreateEbsSnapshotParameters Object
      • AmazonCreateEbsSnapshotsParameters Object
      • AmazonCreateElastiCacheClusterParameters Object
      • AmazonCreateElastiCacheReadReplicaParameters Object
      • AmazonCreateElastiCacheSnapshotsParameters Object
      • AmazonCreateLightsailInstancesFromSnapshotsParameters Object
      • AmazonCreateLightsailInstanceSnapshotsParameters Object
      • AmazonCreateRdsReadReplicaParameters Object
      • AmazonCreateRdsSnapshotParameters Object
      • AmazonCreateRdsSnapshotsParameters Object
      • AmazonCreateRedshiftSnapshotParameters Object
      • AmazonDeleteEbsSnapshotsParameters Object
      • AmazonDeleteEbsVolumesParameters Object
      • AmazonDeleteRdsSnapshotsParameters Object
      • AmazonDeregisterAmiImagesParameters Object
      • AmazonDisableUnusedIamAccessKeysParameters Object
      • AmazonExportDynamoDbTablesParameters Object
      • AmazonRequestEc2SpotInstancesParameters Object
      • AmazonSendSsmCommandParameters Object
      • AmazonStartEc2InstanceParameters Object
      • AmazonStartEc2InstancesParameters Object
      • AmazonTagEbsSnapshotsParameters Object
      • AmazonUpdateAutoScalingGroupsParameters Object
      • AmazonUpdateEcsServicesParameters Object
      • GoogleResizeManagedInstanceGroupsParameters Object
      • GoogleStartVmInstancesParameters Object
      • GoogleStartCloudSqlInstancesParameters Object
    • ActionSchedule Object
    • AllDatabases Object
    • AutoScalingGroupNameComparison Object
    • AmazonIamRoleExternalId Object
    • AmazonIamAccessKeyParameters Object
    • AmazonIamRoleParameters Object
    • AmazonS3Target Object
    • AmiImageDescriptionComparison Object
    • AmiImageNameComparison Object
    • AmiImageTag Object
    • AmiImageVolumeChanges Object
    • AttachVolumeToInstanceParameters Object
    • AzureCredentialParameters Object
    • BackupsReportItem Object
    • BucketNameComparison Object
    • ChangeDeleteOnTerminate Object
    • ChangeEbsVolumeEncryption Object
    • ChangeEbsVolumeSize Object
    • ChangeEbsVolumeType Object
    • CloudFormationParameter Object
    • CloudFormationStackNameComparison Object
    • CloudTrailCloudWatchLogsProperties Object
    • CreateEbsSnapshot Object
    • CreateLightsailInstancesInstance Object
    • Credential Object
    • DatabaseEndpoint Object
    • DaysDetached Object
    • EbsSnapshotDescriptionComparison Object
    • EbsVolumeIdComparison Object
    • EcsClusterNameComparison Object
    • EcsServiceNameComparison Object
    • ElastiCacheClusterIdComparison Object
    • Error Object
    • FirstInFirstOutDeleteSchemeParameters Object
    • GrandfatherFatherSonDeleteSchemeParameters Object
    • GoogleInstanceNameComparison Object
    • GoogleLabelComparison Object
    • GoogleManagedInstanceGroupNameComparison Object
    • GoogleServiceAccountKeyParameters Object
    • IamUserNameComparison Object
    • InstanceNameComparison Object
    • LightsailInstanceNameComparison Object
    • LightsailInstanceSnapshotNameComparison Object
    • ManagedPolicy Object
    • ManagedServicesGroupIdComparison Object
    • ManagedServicesPlan Object
    • ManagedServicesPlanParameters Object
      • ManagedServicesStartStopPlanParameters Object
    • ManagedServicesPlanSchedule Object
    • ManagedServicesResourceIdComparison Object
    • ManagedServicesResourceTagComparison Object
    • ManagedServicesSelector Object
    • MinimumToKeepPeriodParameters Object
    • NameTagComparison Object
    • Project Object
    • ProjectNotification Object
    • ProjectNotificationAmazonSnsSettings Object
    • ProjectNotificationEmailSettings Object
    • ProjectNotificationSlackSettings Object
    • ProjectNotificationsSettings Object
    • ProjectRssFeed Object
    • RdsInstanceIdComparison Object
    • RdsSnapshotIdComparison Object
    • RdsSourceIdComparison Object
    • Region Object
    • ResourceTagComparison Object
    • RollingInstanceStops Object
    • ScheduleParameters Object
      • DailyScheduleParameters Object
      • HourlyScheduleParameters Object
      • NoneScheduleParameters Object
      • MonthlyScheduleParameters Object
      • WeeklyScheduleParameters Object
    • SendSsmCommandParameter Object
    • SpecificDatabases Object
    • SpotInstanceOptions Object
    • StartEc2InstancesInstance Object
    • TableNameComparison Object
    • Tag Object
    • TimeZone Object
    • UpcomingActionExecution Object
    • User Object
    • UserManagedPolicy
    • WeekAndDay Object
Powered by GitBook
On this page
  • Description
  • Properties
  • accountNumber
  • conflictResolutionMethod
  • credentialIds
  • instanceIdComparison
  • isCopyTags
  • isIncludeClusterSnapshots
  • newerThanDays
  • newSnapshotId
  • regionNames
  • resourceTagComparison
  • snapshotIdComparison
  • snapshotIdentificationMethod
  • snapshotType
  • tags
  • targetCredentialId
  • targetKmsKeyOverride
  • targetOptionGroupName
  • targetRegionName
  • Sample JSON
  1. Data Types
  2. ActionParameters Object

AmazonCopyRdsSnapshotsParameters Object

Description

Parameters for the Amazon Copy RDS Snapshots action.

Properties

accountNumber

Account number of the AWS account containing the RDS snapshots. Must be a string of 12 numeric digits.

Type: string

Required: No

conflictResolutionMethod

Method used when an RDS already exists with the desired snapshot ID in the target region.

Type: string

Valid Values:

  • skip

  • delete-and-recopy

  • fail-and-stop

  • fail-and-continue

Default: skip

Required: No

credentialIds

Registered credentials to use with the action. One and only one credential must be specified.

Type: Array of string

Required: Yes

instanceIdComparison

Comparison to use when matching snapshots by their source instance ID. Required when snapshotIdentificationMethod is by-instance-id.

Required: Conditional

isCopyTags

Indicates whether the snapshot tags will be copied from the source to the target snapshot.

Type: boolean

Default: false

Required: No

isIncludeClusterSnapshots

Indicates whether RDS cluster snapshots (ie. Aurora) should be included as well as db snapshots.

Type: boolean

Default: true

Required: No

newerThanDays

Age, in days, used to filter snapshots that are copied. Only snapshots newer than the specified value will be copied. Specify null to indicate no age limit.

Type: integer

Default: null

Required: No

newSnapshotId

ID of the new snapshots.

Type: string

Default: $(SNAPSHOTID)

Required: No

regionNames

Regions to use with the action. Omit (or specify null) to include "all regions".

Type: Array of string

Required: No

resourceTagComparison

Comparison to use when identifying snapshots by resource tag. Required when snapshotIdentificationMethod is by-resource-tag.

Required: Conditional

snapshotIdComparison

Comparison to use when matching snapshots by their ID. Required when snapshotIdentificationMethod is by-snapshot-id.

Required: Conditional

snapshotIdentificationMethod

Method to use to identify snapshots to be deleted.

Type: string

Valid Values:

  • all-snapshots

  • by-snapshot-id

  • by-instance-id

  • by-resource-tag

Required: Yes

snapshotType

Type of snapshot to be copied.

Type: string

Valid Values:

  • all

  • automated

  • manual

Default: all

Required: No

tags

Resource tags to add to the new RDS snapshots.

Required: No

targetCredentialId

Credential ID of the AWS credentials to copy the the RDS snapshot. Eg. cred-12345678.

Type: string

Required: No

targetKmsKeyOverride

ID or alias of the KMS key used to encrypt the RDS snapshots when copied.

Type: string

Required: No

targetOptionGroupName

Name of the RDS option group to assign to the new RDS snapshots

Type: string

Required: No

targetRegionName

System name of the target region into which the snapshots will be copied. Eg. us-east-1

Type: string

Required: Yes

Sample JSON

{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1"
    ],

    "snapshotIdentificationMethod": "by-resource-tag",
    "resourceTagComparison": {
        "tagName": "skeddly:retention",
        "compareType": "equals",
        "tagValue": "7"
    },
    
    "snapshotType": "all",
    "newerThanDays": 2,
    
    "newSnapshotId": "$(SNAPSHOTID)",
    "isCopyTags": true,
    "tags": [
        {
            "key": "skeddly:copied",
            "value": "$(DATE)"
        }
    ],
    "conflictResolutionMethod": "skip",

    "targetRegionName": "us-west-2"
}

PreviousAmazonCopyEc2InstanceParameters ObjectNextAmazonCopyS3ObjectsParameters Object

Last updated 6 years ago

Type: object

Type: object.

Type: object

Type: Array of object.

RdsInstanceIdComparison
ResourceTagComparison
RdsSnapshotIdComparison
Tag