package backup
import "github.com/aws/aws-sdk-go-v2/service/backup"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CreateBackupPlan(ctx context.Context, params *CreateBackupPlanInput, optFns ...func(*Options)) (*CreateBackupPlanOutput, error)
- func (c *Client) CreateBackupSelection(ctx context.Context, params *CreateBackupSelectionInput, optFns ...func(*Options)) (*CreateBackupSelectionOutput, error)
- func (c *Client) CreateBackupVault(ctx context.Context, params *CreateBackupVaultInput, optFns ...func(*Options)) (*CreateBackupVaultOutput, error)
- func (c *Client) DeleteBackupPlan(ctx context.Context, params *DeleteBackupPlanInput, optFns ...func(*Options)) (*DeleteBackupPlanOutput, error)
- func (c *Client) DeleteBackupSelection(ctx context.Context, params *DeleteBackupSelectionInput, optFns ...func(*Options)) (*DeleteBackupSelectionOutput, error)
- func (c *Client) DeleteBackupVault(ctx context.Context, params *DeleteBackupVaultInput, optFns ...func(*Options)) (*DeleteBackupVaultOutput, error)
- func (c *Client) DeleteBackupVaultAccessPolicy(ctx context.Context, params *DeleteBackupVaultAccessPolicyInput, optFns ...func(*Options)) (*DeleteBackupVaultAccessPolicyOutput, error)
- func (c *Client) DeleteBackupVaultNotifications(ctx context.Context, params *DeleteBackupVaultNotificationsInput, optFns ...func(*Options)) (*DeleteBackupVaultNotificationsOutput, error)
- func (c *Client) DeleteRecoveryPoint(ctx context.Context, params *DeleteRecoveryPointInput, optFns ...func(*Options)) (*DeleteRecoveryPointOutput, error)
- func (c *Client) DescribeBackupJob(ctx context.Context, params *DescribeBackupJobInput, optFns ...func(*Options)) (*DescribeBackupJobOutput, error)
- func (c *Client) DescribeBackupVault(ctx context.Context, params *DescribeBackupVaultInput, optFns ...func(*Options)) (*DescribeBackupVaultOutput, error)
- func (c *Client) DescribeCopyJob(ctx context.Context, params *DescribeCopyJobInput, optFns ...func(*Options)) (*DescribeCopyJobOutput, error)
- func (c *Client) DescribeProtectedResource(ctx context.Context, params *DescribeProtectedResourceInput, optFns ...func(*Options)) (*DescribeProtectedResourceOutput, error)
- func (c *Client) DescribeRecoveryPoint(ctx context.Context, params *DescribeRecoveryPointInput, optFns ...func(*Options)) (*DescribeRecoveryPointOutput, error)
- func (c *Client) DescribeRegionSettings(ctx context.Context, params *DescribeRegionSettingsInput, optFns ...func(*Options)) (*DescribeRegionSettingsOutput, error)
- func (c *Client) DescribeRestoreJob(ctx context.Context, params *DescribeRestoreJobInput, optFns ...func(*Options)) (*DescribeRestoreJobOutput, error)
- func (c *Client) ExportBackupPlanTemplate(ctx context.Context, params *ExportBackupPlanTemplateInput, optFns ...func(*Options)) (*ExportBackupPlanTemplateOutput, error)
- func (c *Client) GetBackupPlan(ctx context.Context, params *GetBackupPlanInput, optFns ...func(*Options)) (*GetBackupPlanOutput, error)
- func (c *Client) GetBackupPlanFromJSON(ctx context.Context, params *GetBackupPlanFromJSONInput, optFns ...func(*Options)) (*GetBackupPlanFromJSONOutput, error)
- func (c *Client) GetBackupPlanFromTemplate(ctx context.Context, params *GetBackupPlanFromTemplateInput, optFns ...func(*Options)) (*GetBackupPlanFromTemplateOutput, error)
- func (c *Client) GetBackupSelection(ctx context.Context, params *GetBackupSelectionInput, optFns ...func(*Options)) (*GetBackupSelectionOutput, error)
- func (c *Client) GetBackupVaultAccessPolicy(ctx context.Context, params *GetBackupVaultAccessPolicyInput, optFns ...func(*Options)) (*GetBackupVaultAccessPolicyOutput, error)
- func (c *Client) GetBackupVaultNotifications(ctx context.Context, params *GetBackupVaultNotificationsInput, optFns ...func(*Options)) (*GetBackupVaultNotificationsOutput, error)
- func (c *Client) GetRecoveryPointRestoreMetadata(ctx context.Context, params *GetRecoveryPointRestoreMetadataInput, optFns ...func(*Options)) (*GetRecoveryPointRestoreMetadataOutput, error)
- func (c *Client) GetSupportedResourceTypes(ctx context.Context, params *GetSupportedResourceTypesInput, optFns ...func(*Options)) (*GetSupportedResourceTypesOutput, error)
- func (c *Client) ListBackupJobs(ctx context.Context, params *ListBackupJobsInput, optFns ...func(*Options)) (*ListBackupJobsOutput, error)
- func (c *Client) ListBackupPlanTemplates(ctx context.Context, params *ListBackupPlanTemplatesInput, optFns ...func(*Options)) (*ListBackupPlanTemplatesOutput, error)
- func (c *Client) ListBackupPlanVersions(ctx context.Context, params *ListBackupPlanVersionsInput, optFns ...func(*Options)) (*ListBackupPlanVersionsOutput, error)
- func (c *Client) ListBackupPlans(ctx context.Context, params *ListBackupPlansInput, optFns ...func(*Options)) (*ListBackupPlansOutput, error)
- func (c *Client) ListBackupSelections(ctx context.Context, params *ListBackupSelectionsInput, optFns ...func(*Options)) (*ListBackupSelectionsOutput, error)
- func (c *Client) ListBackupVaults(ctx context.Context, params *ListBackupVaultsInput, optFns ...func(*Options)) (*ListBackupVaultsOutput, error)
- func (c *Client) ListCopyJobs(ctx context.Context, params *ListCopyJobsInput, optFns ...func(*Options)) (*ListCopyJobsOutput, error)
- func (c *Client) ListProtectedResources(ctx context.Context, params *ListProtectedResourcesInput, optFns ...func(*Options)) (*ListProtectedResourcesOutput, error)
- func (c *Client) ListRecoveryPointsByBackupVault(ctx context.Context, params *ListRecoveryPointsByBackupVaultInput, optFns ...func(*Options)) (*ListRecoveryPointsByBackupVaultOutput, error)
- func (c *Client) ListRecoveryPointsByResource(ctx context.Context, params *ListRecoveryPointsByResourceInput, optFns ...func(*Options)) (*ListRecoveryPointsByResourceOutput, error)
- func (c *Client) ListRestoreJobs(ctx context.Context, params *ListRestoreJobsInput, optFns ...func(*Options)) (*ListRestoreJobsOutput, error)
- func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)
- func (c *Client) PutBackupVaultAccessPolicy(ctx context.Context, params *PutBackupVaultAccessPolicyInput, optFns ...func(*Options)) (*PutBackupVaultAccessPolicyOutput, error)
- func (c *Client) PutBackupVaultNotifications(ctx context.Context, params *PutBackupVaultNotificationsInput, optFns ...func(*Options)) (*PutBackupVaultNotificationsOutput, error)
- func (c *Client) StartBackupJob(ctx context.Context, params *StartBackupJobInput, optFns ...func(*Options)) (*StartBackupJobOutput, error)
- func (c *Client) StartCopyJob(ctx context.Context, params *StartCopyJobInput, optFns ...func(*Options)) (*StartCopyJobOutput, error)
- func (c *Client) StartRestoreJob(ctx context.Context, params *StartRestoreJobInput, optFns ...func(*Options)) (*StartRestoreJobOutput, error)
- func (c *Client) StopBackupJob(ctx context.Context, params *StopBackupJobInput, optFns ...func(*Options)) (*StopBackupJobOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateBackupPlan(ctx context.Context, params *UpdateBackupPlanInput, optFns ...func(*Options)) (*UpdateBackupPlanOutput, error)
- func (c *Client) UpdateRecoveryPointLifecycle(ctx context.Context, params *UpdateRecoveryPointLifecycleInput, optFns ...func(*Options)) (*UpdateRecoveryPointLifecycleOutput, error)
- func (c *Client) UpdateRegionSettings(ctx context.Context, params *UpdateRegionSettingsInput, optFns ...func(*Options)) (*UpdateRegionSettingsOutput, error)
- type CreateBackupPlanInput
- type CreateBackupPlanOutput
- type CreateBackupSelectionInput
- type CreateBackupSelectionOutput
- type CreateBackupVaultInput
- type CreateBackupVaultOutput
- type DeleteBackupPlanInput
- type DeleteBackupPlanOutput
- type DeleteBackupSelectionInput
- type DeleteBackupSelectionOutput
- type DeleteBackupVaultAccessPolicyInput
- type DeleteBackupVaultAccessPolicyOutput
- type DeleteBackupVaultInput
- type DeleteBackupVaultNotificationsInput
- type DeleteBackupVaultNotificationsOutput
- type DeleteBackupVaultOutput
- type DeleteRecoveryPointInput
- type DeleteRecoveryPointOutput
- type DescribeBackupJobInput
- type DescribeBackupJobOutput
- type DescribeBackupVaultInput
- type DescribeBackupVaultOutput
- type DescribeCopyJobInput
- type DescribeCopyJobOutput
- type DescribeProtectedResourceInput
- type DescribeProtectedResourceOutput
- type DescribeRecoveryPointInput
- type DescribeRecoveryPointOutput
- type DescribeRegionSettingsInput
- type DescribeRegionSettingsOutput
- type DescribeRestoreJobInput
- type DescribeRestoreJobOutput
- type EndpointResolver
- type EndpointResolverFunc
- type ExportBackupPlanTemplateInput
- type ExportBackupPlanTemplateOutput
- type GetBackupPlanFromJSONInput
- type GetBackupPlanFromJSONOutput
- type GetBackupPlanFromTemplateInput
- type GetBackupPlanFromTemplateOutput
- type GetBackupPlanInput
- type GetBackupPlanOutput
- type GetBackupSelectionInput
- type GetBackupSelectionOutput
- type GetBackupVaultAccessPolicyInput
- type GetBackupVaultAccessPolicyOutput
- type GetBackupVaultNotificationsInput
- type GetBackupVaultNotificationsOutput
- type GetRecoveryPointRestoreMetadataInput
- type GetRecoveryPointRestoreMetadataOutput
- type GetSupportedResourceTypesInput
- type GetSupportedResourceTypesOutput
- type HTTPClient
- type HTTPSignerV4
- type ListBackupJobsInput
- type ListBackupJobsOutput
- type ListBackupPlanTemplatesInput
- type ListBackupPlanTemplatesOutput
- type ListBackupPlanVersionsInput
- type ListBackupPlanVersionsOutput
- type ListBackupPlansInput
- type ListBackupPlansOutput
- type ListBackupSelectionsInput
- type ListBackupSelectionsOutput
- type ListBackupVaultsInput
- type ListBackupVaultsOutput
- type ListCopyJobsInput
- type ListCopyJobsOutput
- type ListProtectedResourcesInput
- type ListProtectedResourcesOutput
- type ListRecoveryPointsByBackupVaultInput
- type ListRecoveryPointsByBackupVaultOutput
- type ListRecoveryPointsByResourceInput
- type ListRecoveryPointsByResourceOutput
- type ListRestoreJobsInput
- type ListRestoreJobsOutput
- type ListTagsInput
- type ListTagsOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type PutBackupVaultAccessPolicyInput
- type PutBackupVaultAccessPolicyOutput
- type PutBackupVaultNotificationsInput
- type PutBackupVaultNotificationsOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type StartBackupJobInput
- type StartBackupJobOutput
- type StartCopyJobInput
- type StartCopyJobOutput
- type StartRestoreJobInput
- type StartRestoreJobOutput
- type StopBackupJobInput
- type StopBackupJobOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateBackupPlanInput
- type UpdateBackupPlanOutput
- type UpdateRecoveryPointLifecycleInput
- type UpdateRecoveryPointLifecycleOutput
- type UpdateRegionSettingsInput
- type UpdateRegionSettingsOutput
Constants ¶
const ServiceAPIVersion = "2018-11-15"
const ServiceID = "Backup"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
AWS Backup AWS Backup is a unified backup service designed to protect AWS services and their associated data. AWS Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateBackupPlan ¶
func (c *Client) CreateBackupPlan(ctx context.Context, params *CreateBackupPlanInput, optFns ...func(*Options)) (*CreateBackupPlanOutput, error)
Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources. If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.
func (*Client) CreateBackupSelection ¶
func (c *Client) CreateBackupSelection(ctx context.Context, params *CreateBackupSelectionInput, optFns ...func(*Options)) (*CreateBackupSelectionOutput, error)
Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources. For example, consider the following patterns:
*
Resources: "arn:aws:ec2:region:account-id:volume/volume-id"
*
ConditionKey:"department"ConditionValue:"finance"ConditionType:"STRINGEQUALS"
* ConditionKey:"importance"ConditionValue:"critical"ConditionType:"STRINGEQUALS"
Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume Id. Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.
func (*Client) CreateBackupVault ¶
func (c *Client) CreateBackupVault(ctx context.Context, params *CreateBackupVaultInput, optFns ...func(*Options)) (*CreateBackupVaultOutput, error)
Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Sensitive data, such as passport numbers, should not be included the name of a backup vault.
func (*Client) DeleteBackupPlan ¶
func (c *Client) DeleteBackupPlan(ctx context.Context, params *DeleteBackupPlanInput, optFns ...func(*Options)) (*DeleteBackupPlanOutput, error)
Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.
func (*Client) DeleteBackupSelection ¶
func (c *Client) DeleteBackupSelection(ctx context.Context, params *DeleteBackupSelectionInput, optFns ...func(*Options)) (*DeleteBackupSelectionOutput, error)
Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
func (*Client) DeleteBackupVault ¶
func (c *Client) DeleteBackupVault(ctx context.Context, params *DeleteBackupVaultInput, optFns ...func(*Options)) (*DeleteBackupVaultOutput, error)
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
func (*Client) DeleteBackupVaultAccessPolicy ¶
func (c *Client) DeleteBackupVaultAccessPolicy(ctx context.Context, params *DeleteBackupVaultAccessPolicyInput, optFns ...func(*Options)) (*DeleteBackupVaultAccessPolicyOutput, error)
Deletes the policy document that manages permissions on a backup vault.
func (*Client) DeleteBackupVaultNotifications ¶
func (c *Client) DeleteBackupVaultNotifications(ctx context.Context, params *DeleteBackupVaultNotificationsInput, optFns ...func(*Options)) (*DeleteBackupVaultNotificationsOutput, error)
Deletes event notifications for the specified backup vault.
func (*Client) DeleteRecoveryPoint ¶
func (c *Client) DeleteRecoveryPoint(ctx context.Context, params *DeleteRecoveryPointInput, optFns ...func(*Options)) (*DeleteRecoveryPointOutput, error)
Deletes the recovery point specified by a recovery point ID.
func (*Client) DescribeBackupJob ¶
func (c *Client) DescribeBackupJob(ctx context.Context, params *DescribeBackupJobInput, optFns ...func(*Options)) (*DescribeBackupJobOutput, error)
Returns metadata associated with creating a backup of a resource.
func (*Client) DescribeBackupVault ¶
func (c *Client) DescribeBackupVault(ctx context.Context, params *DescribeBackupVaultInput, optFns ...func(*Options)) (*DescribeBackupVaultOutput, error)
Returns metadata about a backup vault specified by its name.
func (*Client) DescribeCopyJob ¶
func (c *Client) DescribeCopyJob(ctx context.Context, params *DescribeCopyJobInput, optFns ...func(*Options)) (*DescribeCopyJobOutput, error)
Returns metadata associated with creating a copy of a resource.
func (*Client) DescribeProtectedResource ¶
func (c *Client) DescribeProtectedResource(ctx context.Context, params *DescribeProtectedResourceInput, optFns ...func(*Options)) (*DescribeProtectedResourceOutput, error)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.
func (*Client) DescribeRecoveryPoint ¶
func (c *Client) DescribeRecoveryPoint(ctx context.Context, params *DescribeRecoveryPointInput, optFns ...func(*Options)) (*DescribeRecoveryPointOutput, error)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
func (*Client) DescribeRegionSettings ¶
func (c *Client) DescribeRegionSettings(ctx context.Context, params *DescribeRegionSettingsInput, optFns ...func(*Options)) (*DescribeRegionSettingsOutput, error)
Returns the current service opt-in settings for the Region. If the service has a value set to true, AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt to protect that service's resources in this Region.
func (*Client) DescribeRestoreJob ¶
func (c *Client) DescribeRestoreJob(ctx context.Context, params *DescribeRestoreJobInput, optFns ...func(*Options)) (*DescribeRestoreJobOutput, error)
Returns metadata associated with a restore job that is specified by a job ID.
func (*Client) ExportBackupPlanTemplate ¶
func (c *Client) ExportBackupPlanTemplate(ctx context.Context, params *ExportBackupPlanTemplateInput, optFns ...func(*Options)) (*ExportBackupPlanTemplateOutput, error)
Returns the backup plan that is specified by the plan ID as a backup template.
func (*Client) GetBackupPlan ¶
func (c *Client) GetBackupPlan(ctx context.Context, params *GetBackupPlanInput, optFns ...func(*Options)) (*GetBackupPlanOutput, error)
Returns the body of a backup plan in JSON format, in addition to plan metadata.
func (*Client) GetBackupPlanFromJSON ¶
func (c *Client) GetBackupPlanFromJSON(ctx context.Context, params *GetBackupPlanFromJSONInput, optFns ...func(*Options)) (*GetBackupPlanFromJSONOutput, error)
Returns a valid JSON document specifying a backup plan or an error.
func (*Client) GetBackupPlanFromTemplate ¶
func (c *Client) GetBackupPlanFromTemplate(ctx context.Context, params *GetBackupPlanFromTemplateInput, optFns ...func(*Options)) (*GetBackupPlanFromTemplateOutput, error)
Returns the template specified by its templateId as a backup plan.
func (*Client) GetBackupSelection ¶
func (c *Client) GetBackupSelection(ctx context.Context, params *GetBackupSelectionInput, optFns ...func(*Options)) (*GetBackupSelectionOutput, error)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
func (*Client) GetBackupVaultAccessPolicy ¶
func (c *Client) GetBackupVaultAccessPolicy(ctx context.Context, params *GetBackupVaultAccessPolicyInput, optFns ...func(*Options)) (*GetBackupVaultAccessPolicyOutput, error)
Returns the access policy document that is associated with the named backup vault.
func (*Client) GetBackupVaultNotifications ¶
func (c *Client) GetBackupVaultNotifications(ctx context.Context, params *GetBackupVaultNotificationsInput, optFns ...func(*Options)) (*GetBackupVaultNotificationsOutput, error)
Returns event notifications for the specified backup vault.
func (*Client) GetRecoveryPointRestoreMetadata ¶
func (c *Client) GetRecoveryPointRestoreMetadata(ctx context.Context, params *GetRecoveryPointRestoreMetadataInput, optFns ...func(*Options)) (*GetRecoveryPointRestoreMetadataOutput, error)
Returns a set of metadata key-value pairs that were used to create the backup.
func (*Client) GetSupportedResourceTypes ¶
func (c *Client) GetSupportedResourceTypes(ctx context.Context, params *GetSupportedResourceTypesInput, optFns ...func(*Options)) (*GetSupportedResourceTypesOutput, error)
Returns the AWS resource types supported by AWS Backup.
func (*Client) ListBackupJobs ¶
func (c *Client) ListBackupJobs(ctx context.Context, params *ListBackupJobsInput, optFns ...func(*Options)) (*ListBackupJobsOutput, error)
Returns metadata about your backup jobs.
func (*Client) ListBackupPlanTemplates ¶
func (c *Client) ListBackupPlanTemplates(ctx context.Context, params *ListBackupPlanTemplatesInput, optFns ...func(*Options)) (*ListBackupPlanTemplatesOutput, error)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
func (*Client) ListBackupPlanVersions ¶
func (c *Client) ListBackupPlanVersions(ctx context.Context, params *ListBackupPlanVersionsInput, optFns ...func(*Options)) (*ListBackupPlanVersionsOutput, error)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
func (*Client) ListBackupPlans ¶
func (c *Client) ListBackupPlans(ctx context.Context, params *ListBackupPlansInput, optFns ...func(*Options)) (*ListBackupPlansOutput, error)
Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
func (*Client) ListBackupSelections ¶
func (c *Client) ListBackupSelections(ctx context.Context, params *ListBackupSelectionsInput, optFns ...func(*Options)) (*ListBackupSelectionsOutput, error)
Returns an array containing metadata of the resources associated with the target backup plan.
func (*Client) ListBackupVaults ¶
func (c *Client) ListBackupVaults(ctx context.Context, params *ListBackupVaultsInput, optFns ...func(*Options)) (*ListBackupVaultsOutput, error)
Returns a list of recovery point storage containers along with information about them.
func (*Client) ListCopyJobs ¶
func (c *Client) ListCopyJobs(ctx context.Context, params *ListCopyJobsInput, optFns ...func(*Options)) (*ListCopyJobsOutput, error)
Returns metadata about your copy jobs.
func (*Client) ListProtectedResources ¶
func (c *Client) ListProtectedResources(ctx context.Context, params *ListProtectedResourcesInput, optFns ...func(*Options)) (*ListProtectedResourcesOutput, error)
Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
func (*Client) ListRecoveryPointsByBackupVault ¶
func (c *Client) ListRecoveryPointsByBackupVault(ctx context.Context, params *ListRecoveryPointsByBackupVaultInput, optFns ...func(*Options)) (*ListRecoveryPointsByBackupVaultOutput, error)
Returns detailed information about the recovery points stored in a backup vault.
func (*Client) ListRecoveryPointsByResource ¶
func (c *Client) ListRecoveryPointsByResource(ctx context.Context, params *ListRecoveryPointsByResourceInput, optFns ...func(*Options)) (*ListRecoveryPointsByResourceOutput, error)
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
func (*Client) ListRestoreJobs ¶
func (c *Client) ListRestoreJobs(ctx context.Context, params *ListRestoreJobsInput, optFns ...func(*Options)) (*ListRestoreJobsOutput, error)
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
func (*Client) ListTags ¶
func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault. ListTags are currently only supported with Amazon EFS backups.
func (*Client) PutBackupVaultAccessPolicy ¶
func (c *Client) PutBackupVaultAccessPolicy(ctx context.Context, params *PutBackupVaultAccessPolicyInput, optFns ...func(*Options)) (*PutBackupVaultAccessPolicyOutput, error)
Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
func (*Client) PutBackupVaultNotifications ¶
func (c *Client) PutBackupVaultNotifications(ctx context.Context, params *PutBackupVaultNotificationsInput, optFns ...func(*Options)) (*PutBackupVaultNotificationsOutput, error)
Turns on notifications on a backup vault for the specified topic and events.
func (*Client) StartBackupJob ¶
func (c *Client) StartBackupJob(ctx context.Context, params *StartBackupJobInput, optFns ...func(*Options)) (*StartBackupJobOutput, error)
Starts a job to create a one-time backup of the specified resource.
func (*Client) StartCopyJob ¶
func (c *Client) StartCopyJob(ctx context.Context, params *StartCopyJobInput, optFns ...func(*Options)) (*StartCopyJobOutput, error)
Starts a job to create a one-time copy of the specified resource.
func (*Client) StartRestoreJob ¶
func (c *Client) StartRestoreJob(ctx context.Context, params *StartRestoreJobInput, optFns ...func(*Options)) (*StartRestoreJobOutput, error)
Recovers the saved resource identified by an Amazon Resource Name (ARN). If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.
func (*Client) StopBackupJob ¶
func (c *Client) StopBackupJob(ctx context.Context, params *StopBackupJobInput, optFns ...func(*Options)) (*StopBackupJobOutput, error)
Attempts to cancel a job to create a one-time backup of a resource.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
func (*Client) UpdateBackupPlan ¶
func (c *Client) UpdateBackupPlan(ctx context.Context, params *UpdateBackupPlanInput, optFns ...func(*Options)) (*UpdateBackupPlanOutput, error)
Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.
func (*Client) UpdateRecoveryPointLifecycle ¶
func (c *Client) UpdateRecoveryPointLifecycle(ctx context.Context, params *UpdateRecoveryPointLifecycleInput, optFns ...func(*Options)) (*UpdateRecoveryPointLifecycleOutput, error)
Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
func (*Client) UpdateRegionSettings ¶
func (c *Client) UpdateRegionSettings(ctx context.Context, params *UpdateRegionSettingsInput, optFns ...func(*Options)) (*UpdateRegionSettingsOutput, error)
Updates the current service opt-in settings for the Region. If the service has a value set to true, AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt to protect that service's resources in this Region.
type CreateBackupPlanInput ¶
type CreateBackupPlanInput struct { // Specifies the body of a backup plan. Includes a BackupPlanName and one or more // sets of Rules. BackupPlan *types.BackupPlanInput // To help organize your resources, you can assign your own metadata to the // resources that you create. Each tag is a key-value pair. The specified tags are // assigned to all backups created with this plan. BackupPlanTags map[string]*string // Identifies the request and allows failed requests to be retried without the risk // of executing the operation twice. If the request includes a CreatorRequestId // that matches an existing backup plan, that plan is returned. This parameter is // optional. CreatorRequestId *string }
type CreateBackupPlanOutput ¶
type CreateBackupPlanOutput struct { // The date and time that a backup plan is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. They cannot be edited. VersionId *string // Uniquely identifies a backup plan. BackupPlanId *string // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateBackupSelectionInput ¶
type CreateBackupSelectionInput struct { // A unique string that identifies the request and allows failed requests to be // retried without the risk of executing the operation twice. CreatorRequestId *string // Uniquely identifies the backup plan to be associated with the selection of // resources. BackupPlanId *string // Specifies the body of a request to assign a set of resources to a backup plan. BackupSelection *types.BackupSelection }
type CreateBackupSelectionOutput ¶
type CreateBackupSelectionOutput struct { // Uniquely identifies the body of a request to assign a set of resources to a // backup plan. SelectionId *string // Uniquely identifies a backup plan. BackupPlanId *string // The date and time a backup selection is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateBackupVaultInput ¶
type CreateBackupVaultInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string // The server-side encryption key that is used to protect your backups; for // example, // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. EncryptionKeyArn *string // A unique string that identifies the request and allows failed requests to be // retried without the risk of executing the operation twice. CreatorRequestId *string // Metadata that you can assign to help organize the resources that you create. // Each tag is a key-value pair. BackupVaultTags map[string]*string }
type CreateBackupVaultOutput ¶
type CreateBackupVaultOutput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // The date and time a backup vault is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteBackupPlanInput ¶
type DeleteBackupPlanInput struct { // Uniquely identifies a backup plan. BackupPlanId *string }
type DeleteBackupPlanOutput ¶
type DeleteBackupPlanOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string // The date and time a backup plan is deleted, in Unix format and Coordinated // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. DeletionDate *time.Time // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. Version Ids cannot be edited. VersionId *string // Uniquely identifies a backup plan. BackupPlanId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteBackupSelectionInput ¶
type DeleteBackupSelectionInput struct { // Uniquely identifies a backup plan. BackupPlanId *string // Uniquely identifies the body of a request to assign a set of resources to a // backup plan. SelectionId *string }
type DeleteBackupSelectionOutput ¶
type DeleteBackupSelectionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteBackupVaultAccessPolicyInput ¶
type DeleteBackupVaultAccessPolicyInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string }
type DeleteBackupVaultAccessPolicyOutput ¶
type DeleteBackupVaultAccessPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteBackupVaultInput ¶
type DeleteBackupVaultInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string }
type DeleteBackupVaultNotificationsInput ¶
type DeleteBackupVaultNotificationsInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string }
type DeleteBackupVaultNotificationsOutput ¶
type DeleteBackupVaultNotificationsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteBackupVaultOutput ¶
type DeleteBackupVaultOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteRecoveryPointInput ¶
type DeleteRecoveryPointInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string }
type DeleteRecoveryPointOutput ¶
type DeleteRecoveryPointOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeBackupJobInput ¶
type DescribeBackupJobInput struct { // Uniquely identifies a request to AWS Backup to back up a resource. BackupJobId *string }
type DescribeBackupJobOutput ¶
type DescribeBackupJobOutput struct { // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Specifies the time in Unix format and Coordinated Universal Time (UTC) when a // backup job must be started before it is canceled. The value is calculated by // adding the start window to the scheduled time. So if the scheduled time were // 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on // the date specified. The value of StartBy is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. StartBy *time.Time // Uniquely identifies a request to AWS Backup to back up a resource. BackupJobId *string // A detailed message explaining the status of the job to back up a resource. StatusMessage *string // The date and time that a job to create a backup job is completed, in Unix format // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. CompletionDate *time.Time // An ARN that uniquely identifies a saved resource. The format of the ARN depends // on the resource type. ResourceArn *string // The date and time that a job to back up resources is expected to be completed, // in Unix format and Coordinated Universal Time (UTC). The value of // ExpectedCompletionDate is accurate to milliseconds. For example, the value // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. ExpectedCompletionDate *time.Time // The size, in bytes, of a backup. BackupSizeInBytes *int64 // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string // Specifies the IAM role ARN used to create the target recovery point; for // example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // The type of AWS resource to be backed up; for example, an Amazon Elastic Block // Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) // database. ResourceType *string // Contains identifying information about the creation of a backup job, including // the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the // backup plan that is used to create it. CreatedBy *types.RecoveryPointCreator // The size in bytes transferred to a backup vault at the time that the job status // was queried. BytesTransferred *int64 // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // Returns the account ID that owns the backup job. AccountId *string // The date and time that a backup job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Contains an estimated percentage that is complete of a job at the time the job // status was queried. PercentDone *string // The current state of a resource recovery point. State types.BackupJobState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeBackupVaultInput ¶
type DescribeBackupVaultInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string }
type DescribeBackupVaultOutput ¶
type DescribeBackupVaultOutput struct { // The number of recovery points that are stored in a backup vault. NumberOfRecoveryPoints *int64 // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // The date and time that a backup vault is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // The server-side encryption key that is used to protect your backups; for // example, // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. EncryptionKeyArn *string // A unique string that identifies the request and allows failed requests to be // retried without the risk of executing the operation twice. CreatorRequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeCopyJobInput ¶
type DescribeCopyJobInput struct { // Uniquely identifies a copy job. CopyJobId *string }
type DescribeCopyJobOutput ¶
type DescribeCopyJobOutput struct { // Contains detailed information about a copy job. CopyJob *types.CopyJob // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeProtectedResourceInput ¶
type DescribeProtectedResourceInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. ResourceArn *string }
type DescribeProtectedResourceOutput ¶
type DescribeProtectedResourceOutput struct { // An ARN that uniquely identifies a resource. The format of the ARN depends on the // resource type. ResourceArn *string // The date and time that a resource was last backed up, in Unix format and // Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. LastBackupTime *time.Time // The type of AWS resource saved as a recovery point; for example, an EBS volume // or an Amazon RDS database. ResourceType *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeRecoveryPointInput ¶
type DescribeRecoveryPointInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string }
type DescribeRecoveryPointOutput ¶
type DescribeRecoveryPointOutput struct { // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. AWS Backup transitions and expires backups automatically // according to the lifecycle that you define. Backups that are transitioned to // cold storage must be stored in cold storage for a minimum of 90 days. Therefore, // the “expire after days” setting must be 90 days greater than the “transition to // cold after days” setting. The “transition to cold after days” setting cannot be // changed after a backup has been transitioned to cold. Lifecycle *types.Lifecycle // The size, in bytes, of a backup. BackupSizeInBytes *int64 // An ARN that uniquely identifies a backup vault; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // A status code specifying the state of the recovery point. A partial status // indicates that the recovery point was not successfully re-created and must be // retried. Status types.RecoveryPointStatus // The date and time that a recovery point is created, in Unix format and // Coordinated Universal Time (UTC). The value of CreationDate is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. CreationDate *time.Time // The server-side encryption key used to protect your backups; for example, // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. EncryptionKeyArn *string // Specifies the storage class of the recovery point. Valid values are WARM or // COLD. StorageClass types.StorageClass // Contains identifying information about the creation of a recovery point, // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId // of the backup plan used to create it. CreatedBy *types.RecoveryPointCreator // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // The date and time that a recovery point was last restored, in Unix format and // Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. LastRestoreTime *time.Time // The date and time that a job to create a recovery point is completed, in Unix // format and Coordinated Universal Time (UTC). The value of CompletionDate is // accurate to milliseconds. For example, the value 1516925490.087 represents // Friday, January 26, 2018 12:11:30.087 AM. CompletionDate *time.Time // Specifies the IAM role ARN used to create the target recovery point; for // example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // The type of AWS resource to save as a recovery point; for example, an Amazon // Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service // (Amazon RDS) database. ResourceType *string // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // An ARN that uniquely identifies a saved resource. The format of the ARN depends // on the resource type. ResourceArn *string // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt // timestamps. CalculatedLifecycle *types.CalculatedLifecycle // A Boolean value that is returned as TRUE if the specified recovery point is // encrypted, or FALSE if the recovery point is not encrypted. IsEncrypted *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeRegionSettingsInput ¶
type DescribeRegionSettingsInput struct { }
type DescribeRegionSettingsOutput ¶
type DescribeRegionSettingsOutput struct { // Returns a list of all services along with the opt-in preferences in the region. ResourceTypeOptInPreference map[string]*bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeRestoreJobInput ¶
type DescribeRestoreJobInput struct { // Uniquely identifies the job that restores a recovery point. RestoreJobId *string }
type DescribeRestoreJobOutput ¶
type DescribeRestoreJobOutput struct { // Specifies the IAM role ARN used to create the target recovery point; for // example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // Returns metadata associated with a restore job listed by resource type. ResourceType *string // The date and time that a restore job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // The date and time that a job to restore a recovery point is completed, in Unix // format and Coordinated Universal Time (UTC). The value of CompletionDate is // accurate to milliseconds. For example, the value 1516925490.087 represents // Friday, January 26, 2018 12:11:30.087 AM. CompletionDate *time.Time // Status code specifying the state of the job that is initiated by AWS Backup to // restore a recovery point. Status types.RestoreJobStatus // An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery // point is being restored. The format of the ARN depends on the resource type of // the backed-up resource. CreatedResourceArn *string // The size, in bytes, of the restored resource. BackupSizeInBytes *int64 // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Contains an estimated percentage that is complete of a job at the time the job // status was queried. PercentDone *string // Returns the account ID that owns the restore job. AccountId *string // Uniquely identifies the job that restores a recovery point. RestoreJobId *string // A message showing the status of a job to restore a recovery point. StatusMessage *string // The amount of time in minutes that a job restoring a recovery point is expected // to take. ExpectedCompletionTimeMinutes *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type ExportBackupPlanTemplateInput ¶
type ExportBackupPlanTemplateInput struct { // Uniquely identifies a backup plan. BackupPlanId *string }
type ExportBackupPlanTemplateOutput ¶
type ExportBackupPlanTemplateOutput struct { // The body of a backup plan template in JSON format. This is a signed JSON // document that cannot be modified before being passed to GetBackupPlanFromJSON. BackupPlanTemplateJson *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetBackupPlanFromJSONInput ¶
type GetBackupPlanFromJSONInput struct { // A customer-supplied backup plan document in JSON format. BackupPlanTemplateJson *string }
type GetBackupPlanFromJSONOutput ¶
type GetBackupPlanFromJSONOutput struct { // Specifies the body of a backup plan. Includes a BackupPlanName and one or more // sets of Rules. BackupPlan *types.BackupPlan // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetBackupPlanFromTemplateInput ¶
type GetBackupPlanFromTemplateInput struct { // Uniquely identifies a stored backup plan template. BackupPlanTemplateId *string }
type GetBackupPlanFromTemplateOutput ¶
type GetBackupPlanFromTemplateOutput struct { // Returns the body of a backup plan based on the target template, including the // name, rules, and backup vault of the plan. BackupPlanDocument *types.BackupPlan // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetBackupPlanInput ¶
type GetBackupPlanInput struct { // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. Version IDs cannot be edited. VersionId *string // Uniquely identifies a backup plan. BackupPlanId *string }
type GetBackupPlanOutput ¶
type GetBackupPlanOutput struct { // A unique string that identifies the request and allows failed requests to be // retried without the risk of executing the operation twice. CreatorRequestId *string // Uniquely identifies a backup plan. BackupPlanId *string // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. Version IDs cannot be edited. VersionId *string // The date and time that a backup plan is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // The date and time that a backup plan is deleted, in Unix format and Coordinated // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. DeletionDate *time.Time // The last time a job to back up resources was executed with this backup plan. A // date and time, in Unix format and Coordinated Universal Time (UTC). The value of // LastExecutionDate is accurate to milliseconds. For example, the value // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. LastExecutionDate *time.Time // Specifies the body of a backup plan. Includes a BackupPlanName and one or more // sets of Rules. BackupPlan *types.BackupPlan // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetBackupSelectionInput ¶
type GetBackupSelectionInput struct { // Uniquely identifies the body of a request to assign a set of resources to a // backup plan. SelectionId *string // Uniquely identifies a backup plan. BackupPlanId *string }
type GetBackupSelectionOutput ¶
type GetBackupSelectionOutput struct { // The date and time a backup selection is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Uniquely identifies the body of a request to assign a set of resources to a // backup plan. SelectionId *string // A unique string that identifies the request and allows failed requests to be // retried without the risk of executing the operation twice. CreatorRequestId *string // Uniquely identifies a backup plan. BackupPlanId *string // Specifies the body of a request to assign a set of resources to a backup plan. BackupSelection *types.BackupSelection // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetBackupVaultAccessPolicyInput ¶
type GetBackupVaultAccessPolicyInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string }
type GetBackupVaultAccessPolicyOutput ¶
type GetBackupVaultAccessPolicyOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // The backup vault access policy document in JSON format. Policy *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetBackupVaultNotificationsInput ¶
type GetBackupVaultNotificationsInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string }
type GetBackupVaultNotificationsOutput ¶
type GetBackupVaultNotificationsOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon // SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic. SNSTopicArn *string // An array of events that indicate the status of jobs to back up resources to the // backup vault. BackupVaultEvents []types.BackupVaultEvent // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetRecoveryPointRestoreMetadataInput ¶
type GetRecoveryPointRestoreMetadataInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string }
type GetRecoveryPointRestoreMetadataOutput ¶
type GetRecoveryPointRestoreMetadataOutput struct { // The set of metadata key-value pairs that describes the original configuration of // the backed-up resource. These values vary depending on the service that is being // restored. RestoreMetadata map[string]*string // An ARN that uniquely identifies a backup vault; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetSupportedResourceTypesInput ¶
type GetSupportedResourceTypesInput struct { }
type GetSupportedResourceTypesOutput ¶
type GetSupportedResourceTypesOutput struct { // Contains a string with the supported AWS resource types: // // * DynamoDB for // Amazon DynamoDB // // * EBS for Amazon Elastic Block Store // // * EC2 for Amazon // Elastic Compute Cloud // // * EFS for Amazon Elastic File System // // * RDS for // Amazon Relational Database Service // // * Storage Gateway for AWS Storage // Gateway ResourceTypes []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ListBackupJobsInput ¶
type ListBackupJobsInput struct { // The account ID to list the jobs from. Returns only backup jobs associated with // the specified account ID. ByAccountId *string // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Returns only backup jobs that were created after the specified date. ByCreatedAfter *time.Time // Returns only backup jobs that match the specified resource Amazon Resource Name // (ARN). ByResourceArn *string // Returns only backup jobs that are in the specified state. ByState types.BackupJobState // The maximum number of items to be returned. MaxResults *int32 // Returns only backup jobs for the specified resources: // // * DynamoDB for Amazon // DynamoDB // // * EBS for Amazon Elastic Block Store // // * EC2 for Amazon Elastic // Compute Cloud // // * EFS for Amazon Elastic File System // // * RDS for Amazon // Relational Database Service // // * Storage Gateway for AWS Storage Gateway ByResourceType *string // Returns only backup jobs that were created before the specified date. ByCreatedBefore *time.Time // Returns only backup jobs that will be stored in the specified backup vault. // Backup vaults are identified by names that are unique to the account used to // create them and the AWS Region where they are created. They consist of lowercase // letters, numbers, and hyphens. ByBackupVaultName *string }
type ListBackupJobsOutput ¶
type ListBackupJobsOutput struct { // An array of structures containing metadata about your backup jobs returned in // JSON format. BackupJobs []*types.BackupJob // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListBackupPlanTemplatesInput ¶
type ListBackupPlanTemplatesInput struct { // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string }
type ListBackupPlanTemplatesOutput ¶
type ListBackupPlanTemplatesOutput struct { // An array of template list items containing metadata about your saved templates. BackupPlanTemplatesList []*types.BackupPlanTemplatesListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListBackupPlanVersionsInput ¶
type ListBackupPlanVersionsInput struct { // Uniquely identifies a backup plan. BackupPlanId *string // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string }
type ListBackupPlanVersionsOutput ¶
type ListBackupPlanVersionsOutput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // An array of version list items containing metadata about your backup plans. BackupPlanVersionsList []*types.BackupPlansListMember // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListBackupPlansInput ¶
type ListBackupPlansInput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // The maximum number of items to be returned. MaxResults *int32 // A Boolean value with a default value of FALSE that returns deleted backup plans // when set to TRUE. IncludeDeleted *bool }
type ListBackupPlansOutput ¶
type ListBackupPlansOutput struct { // An array of backup plan list items containing metadata about your saved backup // plans. BackupPlansList []*types.BackupPlansListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListBackupSelectionsInput ¶
type ListBackupSelectionsInput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // The maximum number of items to be returned. MaxResults *int32 // Uniquely identifies a backup plan. BackupPlanId *string }
type ListBackupSelectionsOutput ¶
type ListBackupSelectionsOutput struct { // An array of backup selection list items containing metadata about each resource // in the list. BackupSelectionsList []*types.BackupSelectionsListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListBackupVaultsInput ¶
type ListBackupVaultsInput struct { // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string }
type ListBackupVaultsOutput ¶
type ListBackupVaultsOutput struct { // An array of backup vault list members containing vault metadata, including // Amazon Resource Name (ARN), display name, creation date, number of saved // recovery points, and encryption information if the resources saved in the backup // vault are encrypted. BackupVaultList []*types.BackupVaultListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListCopyJobsInput ¶
type ListCopyJobsInput struct { // The account ID to list the jobs from. Returns only copy jobs associated with the // specified account ID. ByAccountId *string // Returns only copy jobs that match the specified resource Amazon Resource Name // (ARN). ByResourceArn *string // The maximum number of items to be returned. MaxResults *int32 // Returns only copy jobs that are in the specified state. ByState types.CopyJobState // Returns only copy jobs that were created after the specified date. ByCreatedAfter *time.Time // Returns only backup jobs for the specified resources: // // * DynamoDB for Amazon // DynamoDB // // * EBS for Amazon Elastic Block Store // // * EC2 for Amazon Elastic // Compute Cloud // // * EFS for Amazon Elastic File System // // * RDS for Amazon // Relational Database Service // // * Storage Gateway for AWS Storage Gateway ByResourceType *string // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Returns only copy jobs that were created before the specified date. ByCreatedBefore *time.Time // An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to // copy from; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. ByDestinationVaultArn *string }
type ListCopyJobsOutput ¶
type ListCopyJobsOutput struct { // An array of structures containing metadata about your copy jobs returned in JSON // format. CopyJobs []*types.CopyJob // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListProtectedResourcesInput ¶
type ListProtectedResourcesInput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // The maximum number of items to be returned. MaxResults *int32 }
type ListProtectedResourcesOutput ¶
type ListProtectedResourcesOutput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // An array of resources successfully backed up by AWS Backup including the time // the resource was saved, an Amazon Resource Name (ARN) of the resource, and a // resource type. Results []*types.ProtectedResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListRecoveryPointsByBackupVaultInput ¶
type ListRecoveryPointsByBackupVaultInput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string // Returns only recovery points that match the specified resource Amazon Resource // Name (ARN). ByResourceArn *string // Returns only recovery points that match the specified backup plan ID. ByBackupPlanId *string // The maximum number of items to be returned. MaxResults *int32 // Returns only recovery points that were created after the specified timestamp. ByCreatedAfter *time.Time // Returns only recovery points that were created before the specified timestamp. ByCreatedBefore *time.Time // Returns only recovery points that match the specified resource type. ByResourceType *string }
type ListRecoveryPointsByBackupVaultOutput ¶
type ListRecoveryPointsByBackupVaultOutput struct { // An array of objects that contain detailed information about recovery points // saved in a backup vault. RecoveryPoints []*types.RecoveryPointByBackupVault // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListRecoveryPointsByResourceInput ¶
type ListRecoveryPointsByResourceInput struct { // The maximum number of items to be returned. MaxResults *int32 // An ARN that uniquely identifies a resource. The format of the ARN depends on the // resource type. ResourceArn *string // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string }
type ListRecoveryPointsByResourceOutput ¶
type ListRecoveryPointsByResourceOutput struct { // An array of objects that contain detailed information about recovery points of // the specified resource type. RecoveryPoints []*types.RecoveryPointByResource // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListRestoreJobsInput ¶
type ListRestoreJobsInput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // The account ID to list the jobs from. Returns only restore jobs associated with // the specified account ID. ByAccountId *string // Returns only restore jobs that were created after the specified date. ByCreatedAfter *time.Time // Returns only restore jobs associated with the specified job status. ByStatus types.RestoreJobStatus // The maximum number of items to be returned. MaxResults *int32 // Returns only restore jobs that were created before the specified date. ByCreatedBefore *time.Time }
type ListRestoreJobsOutput ¶
type ListRestoreJobsOutput struct { // An array of objects that contain detailed information about jobs to restore // saved resources. RestoreJobs []*types.RestoreJobsListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsInput ¶
type ListTagsInput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the type of resource. Valid targets for ListTags are recovery // points, backup plans, and backup vaults. ResourceArn *string // The maximum number of items to be returned. MaxResults *int32 }
type ListTagsOutput ¶
type ListTagsOutput struct { // To help organize your resources, you can assign your own metadata to the // resources you create. Each tag is a key-value pair. Tags map[string]*string // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type PutBackupVaultAccessPolicyInput ¶
type PutBackupVaultAccessPolicyInput struct { // The backup vault access policy document in JSON format. Policy *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string }
type PutBackupVaultAccessPolicyOutput ¶
type PutBackupVaultAccessPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type PutBackupVaultNotificationsInput ¶
type PutBackupVaultNotificationsInput struct { // An array of events that indicate the status of jobs to back up resources to the // backup vault. BackupVaultEvents []types.BackupVaultEvent // The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s // events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic. SNSTopicArn *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string }
type PutBackupVaultNotificationsOutput ¶
type PutBackupVaultNotificationsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type StartBackupJobInput ¶
type StartBackupJobInput struct { // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. AWS Backup will transition and expire backups automatically // according to the lifecycle that you define. Backups transitioned to cold storage // must be stored in cold storage for a minimum of 90 days. Therefore, the “expire // after days” setting must be 90 days greater than the “transition to cold after // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Lifecycle *types.Lifecycle // A value in minutes after a backup is scheduled before a job will be canceled if // it doesn't start successfully. This value is optional. StartWindowMinutes *int64 // A value in minutes after a backup job is successfully started before it must be // completed or it will be canceled by AWS Backup. This value is optional. CompleteWindowMinutes *int64 // Specifies the IAM role ARN used to create the target recovery point; for // example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // To help organize your resources, you can assign your own metadata to the // resources that you create. Each tag is a key-value pair. RecoveryPointTags map[string]*string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. ResourceArn *string // A customer chosen string that can be used to distinguish between calls to // StartBackupJob. IdempotencyToken *string }
type StartBackupJobOutput ¶
type StartBackupJobOutput struct { // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Uniquely identifies a request to AWS Backup to back up a resource. BackupJobId *string // The date and time that a backup job is started, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StartCopyJobInput ¶
type StartCopyJobInput struct { // The name of a logical source container where backups are stored. Backup vaults // are identified by names that are unique to the account used to create them and // the AWS Region where they are created. They consist of lowercase letters, // numbers, and hyphens. SourceBackupVaultName *string // A customer chosen string that can be used to distinguish between calls to // StartCopyJob. IdempotencyToken *string // An Amazon Resource Name (ARN) that uniquely identifies a destination backup // vault to copy to; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. DestinationBackupVaultArn *string // Specifies the IAM role ARN used to copy the target recovery point; for example, // arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // An ARN that uniquely identifies a recovery point to use for the copy job; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Contains an array of Transition objects specifying how long in days before a // recovery point transitions to cold storage or is deleted. Backups transitioned // to cold storage must be stored in cold storage for a minimum of 90 days. // Therefore, on the console, the “expire after days” setting must be 90 days // greater than the “transition to cold after days” setting. The “transition to // cold after days” setting cannot be changed after a backup has been transitioned // to cold. Lifecycle *types.Lifecycle }
type StartCopyJobOutput ¶
type StartCopyJobOutput struct { // The date and time that a copy job is started, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Uniquely identifies a copy job. CopyJobId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StartRestoreJobInput ¶
type StartRestoreJobInput struct { // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Starts a job to restore a recovery point for one of the following resources: // // // * DynamoDB for Amazon DynamoDB // // * EBS for Amazon Elastic Block Store // // * // EC2 for Amazon Elastic Compute Cloud // // * EFS for Amazon Elastic File System // // // * RDS for Amazon Relational Database Service // // * Storage Gateway for AWS // Storage Gateway ResourceType *string // The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create // the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // A customer chosen string that can be used to distinguish between calls to // StartRestoreJob. IdempotencyToken *string // A set of metadata key-value pairs. Contains information, such as a resource // name, required to restore a recovery point. You can get configuration metadata // about a resource at the time it was backed up by calling // GetRecoveryPointRestoreMetadata. However, values in addition to those provided // by GetRecoveryPointRestoreMetadata might be required to restore a resource. For // example, you might need to provide a new resource name if the original already // exists. You need to specify specific metadata to restore an Amazon Elastic File // System (Amazon EFS) instance: // // * file-system-id: ID of the Amazon EFS file // system that is backed up by AWS Backup. Returned in // GetRecoveryPointRestoreMetadata. // // * Encrypted: A Boolean value that, if // true, specifies that the file system is encrypted. If KmsKeyId is specified, // Encrypted must be set to true. // // * KmsKeyId: Specifies the AWS KMS key that // is used to encrypt the restored file system. // // * PerformanceMode: Specifies // the throughput mode of the file system. // // * CreationToken: A user-supplied // value that ensures the uniqueness (idempotency) of the request. // // * // newFileSystem: A Boolean value that, if true, specifies that the recovery point // is restored to a new Amazon EFS file system. Metadata map[string]*string }
type StartRestoreJobOutput ¶
type StartRestoreJobOutput struct { // Uniquely identifies the job that restores a recovery point. RestoreJobId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StopBackupJobInput ¶
type StopBackupJobInput struct { // Uniquely identifies a request to AWS Backup to back up a resource. BackupJobId *string }
type StopBackupJobOutput ¶
type StopBackupJobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TagResourceInput ¶
type TagResourceInput struct { // Key-value pairs that are used to help organize your resources. You can assign // your own metadata to the resources you create. Tags map[string]*string // An ARN that uniquely identifies a resource. The format of the ARN depends on the // type of the tagged resource. ResourceArn *string }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // A list of keys to identify which key-value tags to remove from a resource. TagKeyList []*string // An ARN that uniquely identifies a resource. The format of the ARN depends on the // type of the tagged resource. ResourceArn *string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateBackupPlanInput ¶
type UpdateBackupPlanInput struct { // Uniquely identifies a backup plan. BackupPlanId *string // Specifies the body of a backup plan. Includes a BackupPlanName and one or more // sets of Rules. BackupPlan *types.BackupPlanInput }
type UpdateBackupPlanOutput ¶
type UpdateBackupPlanOutput struct { // Uniquely identifies a backup plan. BackupPlanId *string // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. Version Ids cannot be edited. VersionId *string // The date and time a backup plan is updated, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateRecoveryPointLifecycleInput ¶
type UpdateRecoveryPointLifecycleInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. AWS Backup transitions and expires backups automatically // according to the lifecycle that you define. Backups transitioned to cold storage // must be stored in cold storage for a minimum of 90 days. Therefore, the “expire // after days” setting must be 90 days greater than the “transition to cold after // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Lifecycle *types.Lifecycle // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string }
type UpdateRecoveryPointLifecycleOutput ¶
type UpdateRecoveryPointLifecycleOutput struct { // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt // timestamps. CalculatedLifecycle *types.CalculatedLifecycle // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. AWS Backup transitions and expires backups automatically // according to the lifecycle that you define. Backups transitioned to cold storage // must be stored in cold storage for a minimum of 90 days. Therefore, the “expire // after days” setting must be 90 days greater than the “transition to cold after // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Lifecycle *types.Lifecycle // An ARN that uniquely identifies a backup vault; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateRegionSettingsInput ¶
type UpdateRegionSettingsInput struct { // Updates the list of services along with the opt-in preferences for the region. ResourceTypeOptInPreference map[string]*bool }
type UpdateRegionSettingsOutput ¶
type UpdateRegionSettingsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_CreateBackupPlan.go api_op_CreateBackupSelection.go api_op_CreateBackupVault.go api_op_DeleteBackupPlan.go api_op_DeleteBackupSelection.go api_op_DeleteBackupVault.go api_op_DeleteBackupVaultAccessPolicy.go api_op_DeleteBackupVaultNotifications.go api_op_DeleteRecoveryPoint.go api_op_DescribeBackupJob.go api_op_DescribeBackupVault.go api_op_DescribeCopyJob.go api_op_DescribeProtectedResource.go api_op_DescribeRecoveryPoint.go api_op_DescribeRegionSettings.go api_op_DescribeRestoreJob.go api_op_ExportBackupPlanTemplate.go api_op_GetBackupPlan.go api_op_GetBackupPlanFromJSON.go api_op_GetBackupPlanFromTemplate.go api_op_GetBackupSelection.go api_op_GetBackupVaultAccessPolicy.go api_op_GetBackupVaultNotifications.go api_op_GetRecoveryPointRestoreMetadata.go api_op_GetSupportedResourceTypes.go api_op_ListBackupJobs.go api_op_ListBackupPlanTemplates.go api_op_ListBackupPlanVersions.go api_op_ListBackupPlans.go api_op_ListBackupSelections.go api_op_ListBackupVaults.go api_op_ListCopyJobs.go api_op_ListProtectedResources.go api_op_ListRecoveryPointsByBackupVault.go api_op_ListRecoveryPointsByResource.go api_op_ListRestoreJobs.go api_op_ListTags.go api_op_PutBackupVaultAccessPolicy.go api_op_PutBackupVaultNotifications.go api_op_StartBackupJob.go api_op_StartCopyJob.go api_op_StartRestoreJob.go api_op_StopBackupJob.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateBackupPlan.go api_op_UpdateRecoveryPointLifecycle.go api_op_UpdateRegionSettings.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.1.0
- Published
- Sep 29, 2020
- Platform
- js/wasm
- Imports
- 26 packages
- Last checked
- now –
Tools for package owners.