sms

package module
v0.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 17, 2020 License: Apache-2.0 Imports: 26 Imported by: 21

Documentation

Overview

Package sms provides the API client, operations, and parameter types for AWS Server Migration Service.

AAWS Sever Migration Service This is the AWS Sever Migration Service API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service (AWS SMS). The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs (http://aws.amazon.com/tools/#SDKs). To learn more about the Server Migration Service, see the following resources:

  • AWS Sever Migration Service product

page (https://aws.amazon.com/server-migration-service/)

  • AWS Sever

Migration Service User Guide (https://docs.aws.amazon.com/server-migration-service/latest/userguide/server-migration.html)

Index

Constants

View Source 
const ServiceAPIVersion = "2016-10-24"
View Source 
const ServiceID = "SMS"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Server Migration Service.

func New 

func New(options Options, optFns ...func(*Options)) *Client

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 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateApp 

func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns ...func(*Options)) (*CreateAppOutput, error)

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

func (*Client) CreateReplicationJob 

func (c *Client) CreateReplicationJob(ctx context.Context, params *CreateReplicationJobInput, optFns ...func(*Options)) (*CreateReplicationJobOutput, error)

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).

func (*Client) DeleteApp 

func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns ...func(*Options)) (*DeleteAppOutput, error)

Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

func (*Client) DeleteAppLaunchConfiguration 

func (c *Client) DeleteAppLaunchConfiguration(ctx context.Context, params *DeleteAppLaunchConfigurationInput, optFns ...func(*Options)) (*DeleteAppLaunchConfigurationOutput, error)

Deletes existing launch configuration for an application.

func (*Client) DeleteAppReplicationConfiguration 

func (c *Client) DeleteAppReplicationConfiguration(ctx context.Context, params *DeleteAppReplicationConfigurationInput, optFns ...func(*Options)) (*DeleteAppReplicationConfigurationOutput, error)

Deletes existing replication configuration for an application.

func (*Client) DeleteReplicationJob 

func (c *Client) DeleteReplicationJob(ctx context.Context, params *DeleteReplicationJobInput, optFns ...func(*Options)) (*DeleteReplicationJobOutput, error)

Deletes the specified replication job. After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.

func (*Client) DeleteServerCatalog 

func (c *Client) DeleteServerCatalog(ctx context.Context, params *DeleteServerCatalogInput, optFns ...func(*Options)) (*DeleteServerCatalogOutput, error)

Deletes all servers from your server catalog.

func (*Client) DisassociateConnector 

func (c *Client) DisassociateConnector(ctx context.Context, params *DisassociateConnectorInput, optFns ...func(*Options)) (*DisassociateConnectorOutput, error)

Disassociates the specified connector from AWS SMS. After you disassociate a connector, it is no longer available to support replication jobs.

func (*Client) GenerateChangeSet 

func (c *Client) GenerateChangeSet(ctx context.Context, params *GenerateChangeSetInput, optFns ...func(*Options)) (*GenerateChangeSetOutput, error)

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

func (*Client) GenerateTemplate 

func (c *Client) GenerateTemplate(ctx context.Context, params *GenerateTemplateInput, optFns ...func(*Options)) (*GenerateTemplateOutput, error)

Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

func (*Client) GetApp 

func (c *Client) GetApp(ctx context.Context, params *GetAppInput, optFns ...func(*Options)) (*GetAppOutput, error)

Retrieve information about an application.

func (*Client) GetAppLaunchConfiguration 

func (c *Client) GetAppLaunchConfiguration(ctx context.Context, params *GetAppLaunchConfigurationInput, optFns ...func(*Options)) (*GetAppLaunchConfigurationOutput, error)

Retrieves the application launch configuration associated with an application.

func (*Client) GetAppReplicationConfiguration 

func (c *Client) GetAppReplicationConfiguration(ctx context.Context, params *GetAppReplicationConfigurationInput, optFns ...func(*Options)) (*GetAppReplicationConfigurationOutput, error)

Retrieves an application replication configuration associatd with an application.

func (*Client) GetConnectors 

func (c *Client) GetConnectors(ctx context.Context, params *GetConnectorsInput, optFns ...func(*Options)) (*GetConnectorsOutput, error)

Describes the connectors registered with the AWS SMS.

func (*Client) GetReplicationJobs 

func (c *Client) GetReplicationJobs(ctx context.Context, params *GetReplicationJobsInput, optFns ...func(*Options)) (*GetReplicationJobsOutput, error)

Describes the specified replication job or all of your replication jobs.

func (*Client) GetReplicationRuns 

func (c *Client) GetReplicationRuns(ctx context.Context, params *GetReplicationRunsInput, optFns ...func(*Options)) (*GetReplicationRunsOutput, error)

Describes the replication runs for the specified replication job.

func (*Client) GetServers 

func (c *Client) GetServers(ctx context.Context, params *GetServersInput, optFns ...func(*Options)) (*GetServersOutput, error)

Describes the servers in your server catalog. Before you can describe your servers, you must import them using ImportServerCatalog.

func (*Client) ImportServerCatalog 

func (c *Client) ImportServerCatalog(ctx context.Context, params *ImportServerCatalogInput, optFns ...func(*Options)) (*ImportServerCatalogOutput, error)

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import. This call returns immediately, but might take additional time to retrieve all the servers.

func (*Client) LaunchApp 

func (c *Client) LaunchApp(ctx context.Context, params *LaunchAppInput, optFns ...func(*Options)) (*LaunchAppOutput, error)

Launches an application stack.

func (*Client) ListApps 

func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ...func(*Options)) (*ListAppsOutput, error)

Returns a list of summaries for all applications.

func (*Client) PutAppLaunchConfiguration 

func (c *Client) PutAppLaunchConfiguration(ctx context.Context, params *PutAppLaunchConfigurationInput, optFns ...func(*Options)) (*PutAppLaunchConfigurationOutput, error)

Creates a launch configuration for an application.

func (*Client) PutAppReplicationConfiguration 

func (c *Client) PutAppReplicationConfiguration(ctx context.Context, params *PutAppReplicationConfigurationInput, optFns ...func(*Options)) (*PutAppReplicationConfigurationOutput, error)

Creates or updates a replication configuration for an application.

func (*Client) StartAppReplication 

func (c *Client) StartAppReplication(ctx context.Context, params *StartAppReplicationInput, optFns ...func(*Options)) (*StartAppReplicationOutput, error)

Starts replicating an application.

func (*Client) StartOnDemandReplicationRun 

func (c *Client) StartOnDemandReplicationRun(ctx context.Context, params *StartOnDemandReplicationRunInput, optFns ...func(*Options)) (*StartOnDemandReplicationRunOutput, error)

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled. There is a limit on the number of on-demand replications runs you can request in a 24-hour period.

func (*Client) StopAppReplication 

func (c *Client) StopAppReplication(ctx context.Context, params *StopAppReplicationInput, optFns ...func(*Options)) (*StopAppReplicationOutput, error)

Stops replicating an application.

func (*Client) TerminateApp 

func (c *Client) TerminateApp(ctx context.Context, params *TerminateAppInput, optFns ...func(*Options)) (*TerminateAppOutput, error)

Terminates the stack for an application.

func (*Client) UpdateApp 

func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns ...func(*Options)) (*UpdateAppOutput, error)

Updates an application.

func (*Client) UpdateReplicationJob 

func (c *Client) UpdateReplicationJob(ctx context.Context, params *UpdateReplicationJobInput, optFns ...func(*Options)) (*UpdateReplicationJobOutput, error)

Updates the specified settings for the specified replication job.

type CreateAppInput 

type CreateAppInput struct {

	// A unique, case-sensitive identifier you provide to ensure idempotency of
	// application creation.
	ClientToken *string

	// Description of the new application
	Description *string

	// Name of the new application.
	Name *string

	// Name of service role in customer's account to be used by AWS SMS.
	RoleName *string

	// List of server groups to include in the application.
	ServerGroups []*types.ServerGroup

	// List of tags to be associated with the application.
	Tags []*types.Tag
}

type CreateAppOutput 

type CreateAppOutput struct {

	// Summary description of the application.
	AppSummary *types.AppSummary

	// List of server groups included in the application.
	ServerGroups []*types.ServerGroup

	// List of taags associated with the application.
	Tags []*types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateReplicationJobInput 

type CreateReplicationJobInput struct {

	// The seed replication time.
	//
	// This member is required.
	SeedReplicationTime *time.Time

	// The identifier of the server.
	//
	// This member is required.
	ServerId *string

	// The description of the replication job.
	Description *string

	// When true, the replication job produces encrypted AMIs. See also KmsKeyId below.
	Encrypted *bool

	// The time between consecutive replication runs, in hours.
	Frequency *int32

	// KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the
	// following:
	//
	//     * KMS key ID
	//
	//     * KMS key alias
	//
	//     * ARN referring to KMS
	// key ID
	//
	//     * ARN referring to KMS key alias
	//
	// If encrypted is true but a KMS key
	// id is not specified, the customer's default KMS key for EBS is used.
	KmsKeyId *string

	// The license type to be used for the AMI created by a successful replication run.
	LicenseType types.LicenseType

	// The maximum number of SMS-created AMIs to retain. The oldest will be deleted
	// once the maximum number is reached and a new AMI is created.
	NumberOfRecentAmisToKeep *int32

	// The name of the IAM role to be used by the AWS SMS.
	RoleName *string

	//
	RunOnce *bool
}

type CreateReplicationJobOutput 

type CreateReplicationJobOutput struct {

	// The unique identifier of the replication job.
	ReplicationJobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAppInput 

type DeleteAppInput struct {

	// ID of the application to delete.
	AppId *string

	// While deleting the application, stop all replication jobs corresponding to the
	// servers in the application.
	ForceStopAppReplication *bool

	// While deleting the application, terminate the stack corresponding to the
	// application.
	ForceTerminateApp *bool
}

type DeleteAppLaunchConfigurationInput 

type DeleteAppLaunchConfigurationInput struct {

	// ID of the application associated with the launch configuration.
	AppId *string
}

type DeleteAppLaunchConfigurationOutput 

type DeleteAppLaunchConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAppOutput 

type DeleteAppOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAppReplicationConfigurationInput 

type DeleteAppReplicationConfigurationInput struct {

	// ID of the application associated with the replication configuration.
	AppId *string
}

type DeleteAppReplicationConfigurationOutput 

type DeleteAppReplicationConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteReplicationJobInput 

type DeleteReplicationJobInput struct {

	// The identifier of the replication job.
	//
	// This member is required.
	ReplicationJobId *string
}

type DeleteReplicationJobOutput 

type DeleteReplicationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteServerCatalogInput 

type DeleteServerCatalogInput struct {
}

type DeleteServerCatalogOutput 

type DeleteServerCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateConnectorInput 

type DisassociateConnectorInput struct {

	// The identifier of the connector.
	//
	// This member is required.
	ConnectorId *string
}

type DisassociateConnectorOutput 

type DisassociateConnectorOutput struct {
	// 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 GenerateChangeSetInput 

type GenerateChangeSetInput struct {

	// ID of the application associated with the change set.
	AppId *string

	// Format for the change set.
	ChangesetFormat types.OutputFormat
}

type GenerateChangeSetOutput 

type GenerateChangeSetOutput struct {

	// Location of the Amazon S3 object.
	S3Location *types.S3Location

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GenerateTemplateInput 

type GenerateTemplateInput struct {

	// ID of the application associated with the Amazon CloudFormation template.
	AppId *string

	// Format for generating the Amazon CloudFormation template.
	TemplateFormat types.OutputFormat
}

type GenerateTemplateOutput 

type GenerateTemplateOutput struct {

	// Location of the Amazon S3 object.
	S3Location *types.S3Location

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAppInput 

type GetAppInput struct {

	// ID of the application whose information is being retrieved.
	AppId *string
}

type GetAppLaunchConfigurationInput 

type GetAppLaunchConfigurationInput struct {

	// ID of the application launch configuration.
	AppId *string
}

type GetAppLaunchConfigurationOutput 

type GetAppLaunchConfigurationOutput struct {

	// ID of the application associated with the launch configuration.
	AppId *string

	// Name of the service role in the customer's account that Amazon CloudFormation
	// uses to launch the application.
	RoleName *string

	// List of launch configurations for server groups in this application.
	ServerGroupLaunchConfigurations []*types.ServerGroupLaunchConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAppOutput 

type GetAppOutput struct {

	// Information about the application.
	AppSummary *types.AppSummary

	// List of server groups belonging to the application.
	ServerGroups []*types.ServerGroup

	// List of tags associated with the application.
	Tags []*types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAppReplicationConfigurationInput 

type GetAppReplicationConfigurationInput struct {

	// ID of the application associated with the replication configuration.
	AppId *string
}

type GetAppReplicationConfigurationOutput 

type GetAppReplicationConfigurationOutput struct {

	// Replication configurations associated with server groups in this application.
	ServerGroupReplicationConfigurations []*types.ServerGroupReplicationConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetConnectorsInput 

type GetConnectorsInput struct {

	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
}

type GetConnectorsOutput 

type GetConnectorsOutput struct {

	// Information about the registered connectors.
	ConnectorList []*types.Connector

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetReplicationJobsInput 

type GetReplicationJobsInput struct {

	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string

	// The identifier of the replication job.
	ReplicationJobId *string
}

type GetReplicationJobsOutput 

type GetReplicationJobsOutput struct {

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the replication jobs.
	ReplicationJobList []*types.ReplicationJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetReplicationRunsInput 

type GetReplicationRunsInput struct {

	// The identifier of the replication job.
	//
	// This member is required.
	ReplicationJobId *string

	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
}

type GetReplicationRunsOutput 

type GetReplicationRunsOutput struct {

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the replication job.
	ReplicationJob *types.ReplicationJob

	// Information about the replication runs.
	ReplicationRunList []*types.ReplicationRun

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetServersInput 

type GetServersInput struct {

	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string

	// List of VmServerAddress objects
	VmServerAddressList []*types.VmServerAddress
}

type GetServersOutput 

type GetServersOutput struct {

	// The time when the server was last modified.
	LastModifiedOn *time.Time

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// The status of the server catalog.
	ServerCatalogStatus types.ServerCatalogStatus

	// Information about the servers.
	ServerList []*types.Server

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

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 ImportServerCatalogInput 

type ImportServerCatalogInput struct {
}

type ImportServerCatalogOutput 

type ImportServerCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type LaunchAppInput 

type LaunchAppInput struct {

	// ID of the application to launch.
	AppId *string
}

type LaunchAppOutput 

type LaunchAppOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAppsInput 

type ListAppsInput struct {

	//
	AppIds []*string

	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
}

type ListAppsOutput 

type ListAppsOutput struct {

	// A list of application summaries.
	Apps []*types.AppSummary

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	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 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PutAppLaunchConfigurationInput 

type PutAppLaunchConfigurationInput struct {

	// ID of the application associated with the launch configuration.
	AppId *string

	// Name of service role in the customer's account that Amazon CloudFormation uses
	// to launch the application.
	RoleName *string

	// Launch configurations for server groups in the application.
	ServerGroupLaunchConfigurations []*types.ServerGroupLaunchConfiguration
}

type PutAppLaunchConfigurationOutput 

type PutAppLaunchConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutAppReplicationConfigurationInput 

type PutAppReplicationConfigurationInput struct {

	// ID of the application tassociated with the replication configuration.
	AppId *string

	// Replication configurations for server groups in the application.
	ServerGroupReplicationConfigurations []*types.ServerGroupReplicationConfiguration
}

type PutAppReplicationConfigurationOutput 

type PutAppReplicationConfigurationOutput 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 ResolverOptions 

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type StartAppReplicationInput 

type StartAppReplicationInput struct {

	// ID of the application to replicate.
	AppId *string
}

type StartAppReplicationOutput 

type StartAppReplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartOnDemandReplicationRunInput 

type StartOnDemandReplicationRunInput struct {

	// The identifier of the replication job.
	//
	// This member is required.
	ReplicationJobId *string

	// The description of the replication run.
	Description *string
}

type StartOnDemandReplicationRunOutput 

type StartOnDemandReplicationRunOutput struct {

	// The identifier of the replication run.
	ReplicationRunId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopAppReplicationInput 

type StopAppReplicationInput struct {

	// ID of the application to stop replicating.
	AppId *string
}

type StopAppReplicationOutput 

type StopAppReplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TerminateAppInput 

type TerminateAppInput struct {

	// ID of the application to terminate.
	AppId *string
}

type TerminateAppOutput 

type TerminateAppOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAppInput 

type UpdateAppInput struct {

	// ID of the application to update.
	AppId *string

	// New description of the application.
	Description *string

	// New name of the application.
	Name *string

	// Name of the service role in the customer's account used by AWS SMS.
	RoleName *string

	// List of server groups in the application to update.
	ServerGroups []*types.ServerGroup

	// List of tags to associate with the application.
	Tags []*types.Tag
}

type UpdateAppOutput 

type UpdateAppOutput struct {

	// Summary description of the application.
	AppSummary *types.AppSummary

	// List of updated server groups in the application.
	ServerGroups []*types.ServerGroup

	// List of tags associated with the application.
	Tags []*types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateReplicationJobInput 

type UpdateReplicationJobInput struct {

	// The identifier of the replication job.
	//
	// This member is required.
	ReplicationJobId *string

	// The description of the replication job.
	Description *string

	// When true, the replication job produces encrypted AMIs . See also KmsKeyId
	// below.
	Encrypted *bool

	// The time between consecutive replication runs, in hours.
	Frequency *int32

	// KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the
	// following:
	//
	//     * KMS key ID
	//
	//     * KMS key alias
	//
	//     * ARN referring to KMS
	// key ID
	//
	//     * ARN referring to KMS key alias
	//
	// If encrypted is true but a KMS key
	// id is not specified, the customer's default KMS key for EBS is used.
	KmsKeyId *string

	// The license type to be used for the AMI created by a successful replication run.
	LicenseType types.LicenseType

	// The start time of the next replication run.
	NextReplicationRunStartTime *time.Time

	// The maximum number of SMS-created AMIs to retain. The oldest will be deleted
	// once the maximum number is reached and a new AMI is created.
	NumberOfRecentAmisToKeep *int32

	// The name of the IAM role to be used by AWS SMS.
	RoleName *string
}

type UpdateReplicationJobOutput 

type UpdateReplicationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.