opsworkscm

package
v0.21.0 Latest Latest
Warning

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

 Go to latest Published: Apr 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 22

Documentation

Overview

Package opsworkscm provides the client and types for making API requests to OpsWorksCM.

AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. You can use AWS OpsWorks CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove nodes for the servers to manage.

Glossary of terms

  • Server: A configuration management server that can be highly-available. The configuration management server runs on an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you create servers, they continue to run until they are deleted.

  • Engine: The engine is the specific configuration manager that you want to use. Valid values in this release include ChefAutomate and Puppet.

  • Backup: This is an application-level backup of the data that the configuration manager stores. AWS OpsWorks CM creates an S3 bucket for backups when you launch the first server. A backup maintains a snapshot of a server's configuration-related attributes at the time the backup starts.

  • Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, when system maintenance is performed, etc. When you delete a server, the server's events are also deleted.

  • Account attributes: Every account has attributes that are assigned in the AWS OpsWorks CM database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.

Endpoints

AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers can only be accessed or managed within the endpoint in which they are created.

  • opsworks-cm.us-east-1.amazonaws.com

  • opsworks-cm.us-east-2.amazonaws.com

  • opsworks-cm.us-west-1.amazonaws.com

  • opsworks-cm.us-west-2.amazonaws.com

  • opsworks-cm.ap-northeast-1.amazonaws.com

  • opsworks-cm.ap-southeast-1.amazonaws.com

  • opsworks-cm.ap-southeast-2.amazonaws.com

  • opsworks-cm.eu-central-1.amazonaws.com

  • opsworks-cm.eu-west-1.amazonaws.com

Throttling limits

All API operations allow for five requests per second with a burst of 10 requests per second.

See https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01 for more information on this service.

See opsworkscm package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/opsworkscm/

Using the Client

To use OpsWorksCM with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the OpsWorksCM client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/opsworkscm/#New

Index

Constants

View Source 
const (
	ServiceName = "OpsWorksCM"  // Service's name
	ServiceID   = "OpsWorksCM"  // Service's identifier
	EndpointsID = "opsworks-cm" // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// This occurs when the provided nextToken is not valid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidStateException for service response error code
	// "InvalidStateException".
	//
	// The resource is in a state that does not allow you to perform a specified
	// action.
	ErrCodeInvalidStateException = "InvalidStateException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The limit of servers or backups has been reached.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The requested resource cannot be created because it already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource does not exist, or access was denied.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// One or more of the provided request parameters are not valid.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountAttribute 

type AccountAttribute struct {

	// The maximum allowed value.
	Maximum *int64 `type:"integer"`

	// The attribute name. The following are supported attribute names.
	//
	//    * ServerLimit: The number of current servers/maximum number of servers
	//    allowed. By default, you can have a maximum of 10 servers.
	//
	//    * ManualBackupLimit: The number of current manual backups/maximum number
	//    of backups allowed. By default, you can have a maximum of 50 manual backups
	//    saved.
	Name *string `type:"string"`

	// The current usage, such as the current number of servers that are associated
	// with the account.
	Used *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Stores account attributes.

func (AccountAttribute) String 

func (s AccountAttribute) String() string

String returns the string representation

type AssociateNodeInput 

type AssociateNodeInput struct {

	// Engine attributes used for associating the node.
	//
	// Attributes accepted in a AssociateNode request for Chef
	//
	//    * CHEF_ORGANIZATION: The Chef organization with which the node is associated.
	//    By default only one organization named default can exist.
	//
	//    * CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required
	//    for the chef-client agent to access the Chef API.
	//
	// Attributes accepted in a AssociateNode request for Puppet
	//
	//    * PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that
	//    is created by the node.
	//
	// EngineAttributes is a required field
	EngineAttributes []EngineAttribute `type:"list" required:"true"`

	// The name of the node.
	//
	// NodeName is a required field
	NodeName *string `type:"string" required:"true"`

	// The name of the server with which to associate the node.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateNodeInput) String 

func (s AssociateNodeInput) String() string

String returns the string representation

func (*AssociateNodeInput) Validate 

func (s *AssociateNodeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateNodeOutput 

type AssociateNodeOutput struct {

	// Contains a token which can be passed to the DescribeNodeAssociationStatus
	// API call to get the status of the association request.
	NodeAssociationStatusToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (AssociateNodeOutput) String 

func (s AssociateNodeOutput) String() string

String returns the string representation

type AssociateNodeRequest 

type AssociateNodeRequest struct {
	*aws.Request
	Input *AssociateNodeInput
	Copy  func(*AssociateNodeInput) AssociateNodeRequest
}

AssociateNodeRequest is the request type for the AssociateNode API operation.

func (AssociateNodeRequest) Send 

func (r AssociateNodeRequest) Send(ctx context.Context) (*AssociateNodeResponse, error)

Send marshals and sends the AssociateNode API request.

type AssociateNodeResponse added in v0.9.0 

type AssociateNodeResponse struct {
	*AssociateNodeOutput
	// contains filtered or unexported fields
}

AssociateNodeResponse is the response type for the AssociateNode API operation.

func (*AssociateNodeResponse) SDKResponseMetdata added in v0.9.0 

func (r *AssociateNodeResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateNode request.

type Backup 

type Backup struct {

	// The ARN of the backup.
	BackupArn *string `type:"string"`

	// The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
	BackupId *string `type:"string"`

	// The backup type. Valid values are automated or manual.
	BackupType BackupType `type:"string" enum:"true"`

	// The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
	CreatedAt *time.Time `type:"timestamp"`

	// A user-provided description for a manual backup. This field is empty for
	// automated backups.
	Description *string `type:"string"`

	// The engine type that is obtained from the server when the backup is created.
	Engine *string `type:"string"`

	// The engine model that is obtained from the server when the backup is created.
	EngineModel *string `type:"string"`

	// The engine version that is obtained from the server when the backup is created.
	EngineVersion *string `type:"string"`

	// The EC2 instance profile ARN that is obtained from the server when the backup
	// is created. Because this value is stored, you are not required to provide
	// the InstanceProfileArn again if you restore a backup.
	InstanceProfileArn *string `type:"string"`

	// The instance type that is obtained from the server when the backup is created.
	InstanceType *string `type:"string"`

	// The key pair that is obtained from the server when the backup is created.
	KeyPair *string `type:"string"`

	// The preferred backup period that is obtained from the server when the backup
	// is created.
	PreferredBackupWindow *string `type:"string"`

	// The preferred maintenance period that is obtained from the server when the
	// backup is created.
	PreferredMaintenanceWindow *string `type:"string"`

	// This field is deprecated and is no longer used.
	S3DataSize *int64 `deprecated:"true" type:"integer"`

	// This field is deprecated and is no longer used.
	S3DataUrl *string `deprecated:"true" type:"string"`

	// The Amazon S3 URL of the backup's log file.
	S3LogUrl *string `type:"string"`

	// The security group IDs that are obtained from the server when the backup
	// is created.
	SecurityGroupIds []string `type:"list"`

	// The name of the server from which the backup was made.
	ServerName *string `min:"1" type:"string"`

	// The service role ARN that is obtained from the server when the backup is
	// created.
	ServiceRoleArn *string `type:"string"`

	// The status of a backup while in progress.
	Status BackupStatus `type:"string" enum:"true"`

	// An informational message about backup status.
	StatusDescription *string `type:"string"`

	// The subnet IDs that are obtained from the server when the backup is created.
	SubnetIds []string `type:"list"`

	// The version of AWS OpsWorks CM-specific tools that is obtained from the server
	// when the backup is created.
	ToolsVersion *string `type:"string"`

	// The IAM user ARN of the requester for manual backups. This field is empty
	// for automated backups.
	UserArn *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a single backup.

func (Backup) String 

func (s Backup) String() string

String returns the string representation

type BackupStatus 

type BackupStatus string
const (
	BackupStatusInProgress BackupStatus = "IN_PROGRESS"
	BackupStatusOk         BackupStatus = "OK"
	BackupStatusFailed     BackupStatus = "FAILED"
	BackupStatusDeleting   BackupStatus = "DELETING"
)

Enum values for BackupStatus

func (BackupStatus) MarshalValue added in v0.3.0 

func (enum BackupStatus) MarshalValue() (string, error)

func (BackupStatus) MarshalValueBuf added in v0.3.0 

func (enum BackupStatus) MarshalValueBuf(b []byte) ([]byte, error)

type BackupType 

type BackupType string
const (
	BackupTypeAutomated BackupType = "AUTOMATED"
	BackupTypeManual    BackupType = "MANUAL"
)

Enum values for BackupType

func (BackupType) MarshalValue added in v0.3.0 

func (enum BackupType) MarshalValue() (string, error)

func (BackupType) MarshalValueBuf added in v0.3.0 

func (enum BackupType) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to OpsWorksCM. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := opsworkscm.New(myConfig)

func (*Client) AssociateNodeRequest added in v0.9.0 

func (c *Client) AssociateNodeRequest(input *AssociateNodeInput) AssociateNodeRequest

AssociateNodeRequest returns a request value for making API operation for AWS OpsWorks CM.

Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

On a Chef server: This command is an alternative to knife bootstrap.

Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem"

On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.

Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem"

A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance. 

// Example sending a request using AssociateNodeRequest.
req := client.AssociateNodeRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/AssociateNode

func (*Client) CreateBackupRequest added in v0.9.0 

func (c *Client) CreateBackupRequest(input *CreateBackupInput) CreateBackupRequest

CreateBackupRequest returns a request value for making API operation for AWS OpsWorks CM.

Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.

Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.

This operation is asynchronous.

A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid. 

// Example sending a request using CreateBackupRequest.
req := client.CreateBackupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateBackup

func (*Client) CreateServerRequest added in v0.9.0 

func (c *Client) CreateServerRequest(input *CreateServerInput) CreateServerRequest

CreateServerRequest returns a request value for making API operation for AWS OpsWorks CM.

Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.

This operation is asynchronous.

A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.

If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.

Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey. 

// Example sending a request using CreateServerRequest.
req := client.CreateServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateServer

func (*Client) DeleteBackupRequest added in v0.9.0 

func (c *Client) DeleteBackupRequest(input *DeleteBackupInput) DeleteBackupRequest

DeleteBackupRequest returns a request value for making API operation for AWS OpsWorks CM.

Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.

An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid. 

// Example sending a request using DeleteBackupRequest.
req := client.DeleteBackupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteBackup

func (*Client) DeleteServerRequest added in v0.9.0 

func (c *Client) DeleteServerRequest(input *DeleteServerInput) DeleteServerRequest

DeleteServerRequest returns a request value for making API operation for AWS OpsWorks CM.

Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. 

// Example sending a request using DeleteServerRequest.
req := client.DeleteServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteServer

func (*Client) DescribeAccountAttributesRequest added in v0.9.0 

func (c *Client) DescribeAccountAttributesRequest(input *DescribeAccountAttributesInput) DescribeAccountAttributesRequest

DescribeAccountAttributesRequest returns a request value for making API operation for AWS OpsWorks CM.

Describes your OpsWorks-CM account attributes.

This operation is synchronous. 

// Example sending a request using DescribeAccountAttributesRequest.
req := client.DescribeAccountAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeAccountAttributes

func (*Client) DescribeBackupsRequest added in v0.9.0 

func (c *Client) DescribeBackupsRequest(input *DescribeBackupsInput) DescribeBackupsRequest

DescribeBackupsRequest returns a request value for making API operation for AWS OpsWorks CM.

Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

This operation is synchronous.

A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid. 

// Example sending a request using DescribeBackupsRequest.
req := client.DescribeBackupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeBackups

func (*Client) DescribeEventsRequest added in v0.9.0 

func (c *Client) DescribeEventsRequest(input *DescribeEventsInput) DescribeEventsRequest

DescribeEventsRequest returns a request value for making API operation for AWS OpsWorks CM.

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. 

// Example sending a request using DescribeEventsRequest.
req := client.DescribeEventsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeEvents

func (*Client) DescribeNodeAssociationStatusRequest added in v0.9.0 

func (c *Client) DescribeNodeAssociationStatusRequest(input *DescribeNodeAssociationStatusInput) DescribeNodeAssociationStatusRequest

DescribeNodeAssociationStatusRequest returns a request value for making API operation for AWS OpsWorks CM.

Returns the current status of an existing association or disassociation request.

A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid. 

// Example sending a request using DescribeNodeAssociationStatusRequest.
req := client.DescribeNodeAssociationStatusRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeNodeAssociationStatus

func (*Client) DescribeServersRequest added in v0.9.0 

func (c *Client) DescribeServersRequest(input *DescribeServersInput) DescribeServersRequest

DescribeServersRequest returns a request value for making API operation for AWS OpsWorks CM.

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. 

// Example sending a request using DescribeServersRequest.
req := client.DescribeServersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeServers

func (*Client) DisassociateNodeRequest added in v0.9.0 

func (c *Client) DisassociateNodeRequest(input *DisassociateNodeInput) DisassociateNodeRequest

DisassociateNodeRequest returns a request value for making API operation for AWS OpsWorks CM.

Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.

A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. 

// Example sending a request using DisassociateNodeRequest.
req := client.DisassociateNodeRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DisassociateNode

func (*Client) ExportServerEngineAttributeRequest added in v0.9.0 

func (c *Client) ExportServerEngineAttributeRequest(input *ExportServerEngineAttributeInput) ExportServerEngineAttributeRequest

ExportServerEngineAttributeRequest returns a request value for making API operation for AWS OpsWorks CM.

Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.

This operation is synchronous.

A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING. 

// Example sending a request using ExportServerEngineAttributeRequest.
req := client.ExportServerEngineAttributeRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/ExportServerEngineAttribute

func (*Client) ListTagsForResourceRequest added in v0.19.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS OpsWorks CM.

Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/ListTagsForResource

func (*Client) RestoreServerRequest added in v0.9.0 

func (c *Client) RestoreServerRequest(input *RestoreServerInput) RestoreServerRequest

RestoreServerRequest returns a request value for making API operation for AWS OpsWorks CM.

Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.

Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a Running or Stopped state, but is eventually terminated.

This operation is asynchronous.

An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. 

// Example sending a request using RestoreServerRequest.
req := client.RestoreServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/RestoreServer

func (*Client) StartMaintenanceRequest added in v0.9.0 

func (c *Client) StartMaintenanceRequest(input *StartMaintenanceInput) StartMaintenanceRequest

StartMaintenanceRequest returns a request value for making API operation for AWS OpsWorks CM.

Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.

Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. 

// Example sending a request using StartMaintenanceRequest.
req := client.StartMaintenanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/StartMaintenance

func (*Client) TagResourceRequest added in v0.19.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS OpsWorks CM.

Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/TagResource

func (*Client) UntagResourceRequest added in v0.19.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS OpsWorks CM.

Removes specified tags from an AWS OpsWorks-CM server or backup. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UntagResource

func (*Client) UpdateServerEngineAttributesRequest added in v0.9.0 

func (c *Client) UpdateServerEngineAttributesRequest(input *UpdateServerEngineAttributesInput) UpdateServerEngineAttributesRequest

UpdateServerEngineAttributesRequest returns a request value for making API operation for AWS OpsWorks CM.

Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD).

This operation is asynchronous.

This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. 

// Example sending a request using UpdateServerEngineAttributesRequest.
req := client.UpdateServerEngineAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServerEngineAttributes

func (*Client) UpdateServerRequest added in v0.9.0 

func (c *Client) UpdateServerRequest(input *UpdateServerInput) UpdateServerRequest

UpdateServerRequest returns a request value for making API operation for AWS OpsWorks CM.

Updates settings for a server.

This operation is synchronous. 

// Example sending a request using UpdateServerRequest.
req := client.UpdateServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServer

func (*Client) WaitUntilNodeAssociated added in v0.9.0 

func (c *Client) WaitUntilNodeAssociated(ctx context.Context, input *DescribeNodeAssociationStatusInput, opts ...aws.WaiterOption) error

WaitUntilNodeAssociated uses the OpsWorksCM API operation DescribeNodeAssociationStatus to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CreateBackupInput 

type CreateBackupInput struct {

	// A user-defined description of the backup.
	Description *string `type:"string"`

	// The name of the server that you want to back up.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`

	// A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM
	// server backup.
	//
	//    * The key cannot be empty.
	//
	//    * The key can be a maximum of 127 characters, and can contain only Unicode
	//    letters, numbers, or separators, or the following special characters:
	//    + - = . _ : /
	//
	//    * The value can be a maximum 255 characters, and contain only Unicode
	//    letters, numbers, or separators, or the following special characters:
	//    + - = . _ : /
	//
	//    * Leading and trailing white spaces are trimmed from both the key and
	//    value.
	//
	//    * A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM
	//    resources.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateBackupInput) String 

func (s CreateBackupInput) String() string

String returns the string representation

func (*CreateBackupInput) Validate 

func (s *CreateBackupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBackupOutput 

type CreateBackupOutput struct {

	// Backup created by request.
	Backup *Backup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateBackupOutput) String 

func (s CreateBackupOutput) String() string

String returns the string representation

type CreateBackupRequest 

type CreateBackupRequest struct {
	*aws.Request
	Input *CreateBackupInput
	Copy  func(*CreateBackupInput) CreateBackupRequest
}

CreateBackupRequest is the request type for the CreateBackup API operation.

func (CreateBackupRequest) Send 

func (r CreateBackupRequest) Send(ctx context.Context) (*CreateBackupResponse, error)

Send marshals and sends the CreateBackup API request.

type CreateBackupResponse added in v0.9.0 

type CreateBackupResponse struct {
	*CreateBackupOutput
	// contains filtered or unexported fields
}

CreateBackupResponse is the response type for the CreateBackup API operation.

func (*CreateBackupResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateBackup request.

type CreateServerInput 

type CreateServerInput struct {

	// Associate a public IP address with a server that you are launching. Valid
	// values are true or false. The default value is true.
	AssociatePublicIpAddress *bool `type:"boolean"`

	// If you specify this field, AWS OpsWorks CM creates the server by using the
	// backup represented by BackupId.
	BackupId *string `type:"string"`

	// The number of automated backups that you want to keep. Whenever a new backup
	// is created, AWS OpsWorks CM deletes the oldest backups if this number is
	// exceeded. The default value is 1.
	BackupRetentionCount *int64 `min:"1" type:"integer"`

	// A PEM-formatted HTTPS certificate. The value can be be a single, self-signed
	// certificate, or a certificate chain. If you specify a custom certificate,
	// you must also specify values for CustomDomain and CustomPrivateKey. The following
	// are requirements for the CustomCertificate value:
	//
	//    * You can provide either a self-signed, custom certificate, or the full
	//    certificate chain.
	//
	//    * The certificate must be a valid X509 certificate, or a certificate chain
	//    in PEM format.
	//
	//    * The certificate must be valid at the time of upload. A certificate can't
	//    be used before its validity period begins (the certificate's NotBefore
	//    date), or after it expires (the certificate's NotAfter date).
	//
	//    * The certificate’s common name or subject alternative names (SANs),
	//    if present, must match the value of CustomDomain.
	//
	//    * The certificate must match the value of CustomPrivateKey.
	CustomCertificate *string `type:"string"`

	// An optional public endpoint of a server, such as https://aws.my-company.com.
	// To access the server, create a CNAME DNS record in your preferred DNS service
	// that points the custom domain to the endpoint that is generated when the
	// server is created (the value of the CreateServer Endpoint attribute). You
	// cannot access the server by using the generated Endpoint value if the server
	// is using a custom domain. If you specify a custom domain, you must also specify
	// values for CustomCertificate and CustomPrivateKey.
	CustomDomain *string `type:"string"`

	// A private key in PEM format for connecting to the server by using HTTPS.
	// The private key must not be encrypted; it cannot be protected by a password
	// or passphrase. If you specify a custom private key, you must also specify
	// values for CustomDomain and CustomCertificate.
	CustomPrivateKey *string `type:"string" sensitive:"true"`

	// Enable or disable scheduled backups. Valid values are true or false. The
	// default value is true.
	DisableAutomatedBackup *bool `type:"boolean"`

	// The configuration management engine to use. Valid values include ChefAutomate
	// and Puppet.
	Engine *string `type:"string"`

	// Optional engine attributes on a specified server.
	//
	// Attributes accepted in a Chef createServer request:
	//
	//    * CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding
	//    private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY
	//    is set, a private key is generated and returned in the response.
	//
	//    * CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user
	//    in the Chef Automate web-based dashboard. The password length is a minimum
	//    of eight characters, and a maximum of 32. The password can contain letters,
	//    numbers, and special characters (!/@#$%^&+=_). The password must contain
	//    at least one lower case letter, one upper case letter, one number, and
	//    one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one
	//    is generated and returned in the response.
	//
	// Attributes accepted in a Puppet createServer request:
	//
	//    * PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a
	//    password must use ASCII characters.
	//
	//    * PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository
	//    (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying
	//    an r10k remote opens TCP port 8170.
	//
	//    * PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository,
	//    add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
	EngineAttributes []EngineAttribute `type:"list"`

	// The engine model of the server. Valid values in this release include Monolithic
	// for Puppet and Single for Chef.
	EngineModel *string `type:"string"`

	// The major release version of the engine that you want to use. For a Chef
	// server, the valid value for EngineVersion is currently 12. For a Puppet server,
	// the valid value is 2017.
	EngineVersion *string `type:"string"`

	// The ARN of the instance profile that your Amazon EC2 instances use. Although
	// the AWS OpsWorks console typically creates the instance profile for you,
	// if you are using API commands instead, run the service-role-creation.yaml
	// AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.
	// This template creates a CloudFormation stack that includes the instance profile
	// you need.
	//
	// InstanceProfileArn is a required field
	InstanceProfileArn *string `type:"string" required:"true"`

	// The Amazon EC2 instance type to use. For example, m5.large.
	//
	// InstanceType is a required field
	InstanceType *string `type:"string" required:"true"`

	// The Amazon EC2 key pair to set for the instance. This parameter is optional;
	// if desired, you may specify this parameter to connect to your instances by
	// using SSH.
	KeyPair *string `type:"string"`

	// The start time for a one-hour period during which AWS OpsWorks CM backs up
	// application-level data on your server if automated backups are enabled. Valid
	// values must be specified in one of the following formats:
	//
	//    * HH:MM for daily backups
	//
	//    * DDD:HH:MM for weekly backups
	//
	// The specified time is in coordinated universal time (UTC). The default value
	// is a random, daily start time.
	//
	// Example: 08:00, which represents a daily start time of 08:00 UTC.
	//
	// Example: Mon:08:00, which represents a start time of every Monday at 08:00
	// UTC. (8:00 a.m.)
	PreferredBackupWindow *string `type:"string"`

	// The start time for a one-hour period each week during which AWS OpsWorks
	// CM performs maintenance on the instance. Valid values must be specified in
	// the following format: DDD:HH:MM. The specified time is in coordinated universal
	// time (UTC). The default value is a random one-hour period on Tuesday, Wednesday,
	// or Friday. See TimeWindowDefinition for more information.
	//
	// Example: Mon:08:00, which represents a start time of every Monday at 08:00
	// UTC. (8:00 a.m.)
	PreferredMaintenanceWindow *string `type:"string"`

	// A list of security group IDs to attach to the Amazon EC2 instance. If you
	// add this parameter, the specified security groups must be within the VPC
	// that is specified by SubnetIds.
	//
	// If you do not specify this parameter, AWS OpsWorks CM creates one new security
	// group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
	SecurityGroupIds []string `type:"list"`

	// The name of the server. The server name must be unique within your AWS account,
	// within each region. Server names must start with a letter; then letters,
	// numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`

	// The service role that the AWS OpsWorks CM service backend uses to work with
	// your account. Although the AWS OpsWorks management console typically creates
	// the service role for you, if you are using the AWS CLI or API commands, run
	// the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.
	// This template creates a CloudFormation stack that includes the service role
	// and instance profile that you need.
	//
	// ServiceRoleArn is a required field
	ServiceRoleArn *string `type:"string" required:"true"`

	// The IDs of subnets in which to launch the server EC2 instance.
	//
	// Amazon EC2-Classic customers: This field is required. All servers must run
	// within a VPC. The VPC must have "Auto Assign Public IP" enabled.
	//
	// EC2-VPC customers: This field is optional. If you do not specify subnet IDs,
	// your EC2 instances are created in a default subnet that is selected by Amazon
	// EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP"
	// enabled.
	//
	// For more information about supported Amazon EC2 platforms, see Supported
	// Platforms (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html).
	SubnetIds []string `type:"list"`

	// A map that contains tag keys and tag values to attach to an AWS OpsWorks
	// for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
	//
	//    * The key cannot be empty.
	//
	//    * The key can be a maximum of 127 characters, and can contain only Unicode
	//    letters, numbers, or separators, or the following special characters:
	//    + - = . _ : / @
	//
	//    * The value can be a maximum 255 characters, and contain only Unicode
	//    letters, numbers, or separators, or the following special characters:
	//    + - = . _ : / @
	//
	//    * Leading and trailing white spaces are trimmed from both the key and
	//    value.
	//
	//    * A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM
	//    server.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateServerInput) String 

func (s CreateServerInput) String() string

String returns the string representation

func (*CreateServerInput) Validate 

func (s *CreateServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateServerOutput 

type CreateServerOutput struct {

	// The server that is created by the request.
	Server *Server `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateServerOutput) String 

func (s CreateServerOutput) String() string

String returns the string representation

type CreateServerRequest 

type CreateServerRequest struct {
	*aws.Request
	Input *CreateServerInput
	Copy  func(*CreateServerInput) CreateServerRequest
}

CreateServerRequest is the request type for the CreateServer API operation.

func (CreateServerRequest) Send 

func (r CreateServerRequest) Send(ctx context.Context) (*CreateServerResponse, error)

Send marshals and sends the CreateServer API request.

type CreateServerResponse added in v0.9.0 

type CreateServerResponse struct {
	*CreateServerOutput
	// contains filtered or unexported fields
}

CreateServerResponse is the response type for the CreateServer API operation.

func (*CreateServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateServer request.

type DeleteBackupInput 

type DeleteBackupInput struct {

	// The ID of the backup to delete. Run the DescribeBackups command to get a
	// list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.
	//
	// BackupId is a required field
	BackupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBackupInput) String 

func (s DeleteBackupInput) String() string

String returns the string representation

func (*DeleteBackupInput) Validate 

func (s *DeleteBackupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupOutput 

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

func (DeleteBackupOutput) String 

func (s DeleteBackupOutput) String() string

String returns the string representation

type DeleteBackupRequest 

type DeleteBackupRequest struct {
	*aws.Request
	Input *DeleteBackupInput
	Copy  func(*DeleteBackupInput) DeleteBackupRequest
}

DeleteBackupRequest is the request type for the DeleteBackup API operation.

func (DeleteBackupRequest) Send 

func (r DeleteBackupRequest) Send(ctx context.Context) (*DeleteBackupResponse, error)

Send marshals and sends the DeleteBackup API request.

type DeleteBackupResponse added in v0.9.0 

type DeleteBackupResponse struct {
	*DeleteBackupOutput
	// contains filtered or unexported fields
}

DeleteBackupResponse is the response type for the DeleteBackup API operation.

func (*DeleteBackupResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBackup request.

type DeleteServerInput 

type DeleteServerInput struct {

	// The ID of the server to delete.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteServerInput) String 

func (s DeleteServerInput) String() string

String returns the string representation

func (*DeleteServerInput) Validate 

func (s *DeleteServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteServerOutput 

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

func (DeleteServerOutput) String 

func (s DeleteServerOutput) String() string

String returns the string representation

type DeleteServerRequest 

type DeleteServerRequest struct {
	*aws.Request
	Input *DeleteServerInput
	Copy  func(*DeleteServerInput) DeleteServerRequest
}

DeleteServerRequest is the request type for the DeleteServer API operation.

func (DeleteServerRequest) Send 

func (r DeleteServerRequest) Send(ctx context.Context) (*DeleteServerResponse, error)

Send marshals and sends the DeleteServer API request.

type DeleteServerResponse added in v0.9.0 

type DeleteServerResponse struct {
	*DeleteServerOutput
	// contains filtered or unexported fields
}

DeleteServerResponse is the response type for the DeleteServer API operation.

func (*DeleteServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteServer request.

type DescribeAccountAttributesInput 

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

func (DescribeAccountAttributesInput) String 

func (s DescribeAccountAttributesInput) String() string

String returns the string representation

type DescribeAccountAttributesOutput 

type DescribeAccountAttributesOutput struct {

	// The attributes that are currently set for the account.
	Attributes []AccountAttribute `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeAccountAttributesOutput) String 

func (s DescribeAccountAttributesOutput) String() string

String returns the string representation

type DescribeAccountAttributesRequest 

type DescribeAccountAttributesRequest struct {
	*aws.Request
	Input *DescribeAccountAttributesInput
	Copy  func(*DescribeAccountAttributesInput) DescribeAccountAttributesRequest
}

DescribeAccountAttributesRequest is the request type for the DescribeAccountAttributes API operation.

func (DescribeAccountAttributesRequest) Send 

func (r DescribeAccountAttributesRequest) Send(ctx context.Context) (*DescribeAccountAttributesResponse, error)

Send marshals and sends the DescribeAccountAttributes API request.

type DescribeAccountAttributesResponse added in v0.9.0 

type DescribeAccountAttributesResponse struct {
	*DescribeAccountAttributesOutput
	// contains filtered or unexported fields
}

DescribeAccountAttributesResponse is the response type for the DescribeAccountAttributes API operation.

func (*DescribeAccountAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeAccountAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAccountAttributes request.

type DescribeBackupsInput 

type DescribeBackupsInput struct {

	// Describes a single backup.
	BackupId *string `type:"string"`

	// This is not currently implemented for DescribeBackups requests.
	MaxResults *int64 `min:"1" type:"integer"`

	// This is not currently implemented for DescribeBackups requests.
	NextToken *string `type:"string"`

	// Returns backups for the server with the specified ServerName.
	ServerName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeBackupsInput) String 

func (s DescribeBackupsInput) String() string

String returns the string representation

func (*DescribeBackupsInput) Validate 

func (s *DescribeBackupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBackupsOutput 

type DescribeBackupsOutput struct {

	// Contains the response to a DescribeBackups request.
	Backups []Backup `type:"list"`

	// This is not currently implemented for DescribeBackups requests.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeBackupsOutput) String 

func (s DescribeBackupsOutput) String() string

String returns the string representation

type DescribeBackupsPaginator added in v0.21.0 

type DescribeBackupsPaginator struct {
	aws.Pager
}

DescribeBackupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeBackupsPaginator added in v0.21.0 

func NewDescribeBackupsPaginator(req DescribeBackupsRequest) DescribeBackupsPaginator

NewDescribeBackupsRequestPaginator returns a paginator for DescribeBackups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeBackupsRequest(input)
p := opsworkscm.NewDescribeBackupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeBackupsPaginator) CurrentPage added in v0.21.0 

func (p *DescribeBackupsPaginator) CurrentPage() *DescribeBackupsOutput

type DescribeBackupsRequest 

type DescribeBackupsRequest struct {
	*aws.Request
	Input *DescribeBackupsInput
	Copy  func(*DescribeBackupsInput) DescribeBackupsRequest
}

DescribeBackupsRequest is the request type for the DescribeBackups API operation.

func (DescribeBackupsRequest) Send 

func (r DescribeBackupsRequest) Send(ctx context.Context) (*DescribeBackupsResponse, error)

Send marshals and sends the DescribeBackups API request.

type DescribeBackupsResponse added in v0.9.0 

type DescribeBackupsResponse struct {
	*DescribeBackupsOutput
	// contains filtered or unexported fields
}

DescribeBackupsResponse is the response type for the DescribeBackups API operation.

func (*DescribeBackupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeBackupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeBackups request.

type DescribeEventsInput 

type DescribeEventsInput struct {

	// To receive a paginated response, use this parameter to specify the maximum
	// number of results to be returned with a single call. If the number of available
	// results exceeds this maximum, the response includes a NextToken value that
	// you can assign to the NextToken request parameter to get the next set of
	// results.
	MaxResults *int64 `min:"1" type:"integer"`

	// NextToken is a string that is returned in some command responses. It indicates
	// that not all entries have been returned, and that you must run at least one
	// more request to get remaining items. To get remaining results, call DescribeEvents
	// again, and assign the token from the previous results as the value of the
	// nextToken parameter. If there are no more results, the response object's
	// nextToken parameter value is null. Setting a nextToken value that was not
	// returned in your previous results causes an InvalidNextTokenException to
	// occur.
	NextToken *string `type:"string"`

	// The name of the server for which you want to view events.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEventsInput) String 

func (s DescribeEventsInput) String() string

String returns the string representation

func (*DescribeEventsInput) Validate 

func (s *DescribeEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventsOutput 

type DescribeEventsOutput struct {

	// NextToken is a string that is returned in some command responses. It indicates
	// that not all entries have been returned, and that you must run at least one
	// more request to get remaining items. To get remaining results, call DescribeEvents
	// again, and assign the token from the previous results as the value of the
	// nextToken parameter. If there are no more results, the response object's
	// nextToken parameter value is null. Setting a nextToken value that was not
	// returned in your previous results causes an InvalidNextTokenException to
	// occur.
	NextToken *string `type:"string"`

	// Contains the response to a DescribeEvents request.
	ServerEvents []ServerEvent `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeEventsOutput) String 

func (s DescribeEventsOutput) String() string

String returns the string representation

type DescribeEventsPaginator added in v0.21.0 

type DescribeEventsPaginator struct {
	aws.Pager
}

DescribeEventsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeEventsPaginator added in v0.21.0 

func NewDescribeEventsPaginator(req DescribeEventsRequest) DescribeEventsPaginator

NewDescribeEventsRequestPaginator returns a paginator for DescribeEvents. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeEventsRequest(input)
p := opsworkscm.NewDescribeEventsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeEventsPaginator) CurrentPage added in v0.21.0 

func (p *DescribeEventsPaginator) CurrentPage() *DescribeEventsOutput

type DescribeEventsRequest 

type DescribeEventsRequest struct {
	*aws.Request
	Input *DescribeEventsInput
	Copy  func(*DescribeEventsInput) DescribeEventsRequest
}

DescribeEventsRequest is the request type for the DescribeEvents API operation.

func (DescribeEventsRequest) Send 

func (r DescribeEventsRequest) Send(ctx context.Context) (*DescribeEventsResponse, error)

Send marshals and sends the DescribeEvents API request.

type DescribeEventsResponse added in v0.9.0 

type DescribeEventsResponse struct {
	*DescribeEventsOutput
	// contains filtered or unexported fields
}

DescribeEventsResponse is the response type for the DescribeEvents API operation.

func (*DescribeEventsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEventsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEvents request.

type DescribeNodeAssociationStatusInput 

type DescribeNodeAssociationStatusInput struct {

	// The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.
	//
	// NodeAssociationStatusToken is a required field
	NodeAssociationStatusToken *string `type:"string" required:"true"`

	// The name of the server from which to disassociate the node.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeNodeAssociationStatusInput) String 

func (s DescribeNodeAssociationStatusInput) String() string

String returns the string representation

func (*DescribeNodeAssociationStatusInput) Validate 

func (s *DescribeNodeAssociationStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeNodeAssociationStatusOutput 

type DescribeNodeAssociationStatusOutput struct {

	// Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT
	// contains the signed certificate (the result of the CSR).
	EngineAttributes []EngineAttribute `type:"list"`

	// The status of the association or disassociation request.
	//
	// Possible values:
	//
	//    * SUCCESS: The association or disassociation succeeded.
	//
	//    * FAILED: The association or disassociation failed.
	//
	//    * IN_PROGRESS: The association or disassociation is still in progress.
	NodeAssociationStatus NodeAssociationStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (DescribeNodeAssociationStatusOutput) String 

func (s DescribeNodeAssociationStatusOutput) String() string

String returns the string representation

type DescribeNodeAssociationStatusRequest 

type DescribeNodeAssociationStatusRequest struct {
	*aws.Request
	Input *DescribeNodeAssociationStatusInput
	Copy  func(*DescribeNodeAssociationStatusInput) DescribeNodeAssociationStatusRequest
}

DescribeNodeAssociationStatusRequest is the request type for the DescribeNodeAssociationStatus API operation.

func (DescribeNodeAssociationStatusRequest) Send 

func (r DescribeNodeAssociationStatusRequest) Send(ctx context.Context) (*DescribeNodeAssociationStatusResponse, error)

Send marshals and sends the DescribeNodeAssociationStatus API request.

type DescribeNodeAssociationStatusResponse added in v0.9.0 

type DescribeNodeAssociationStatusResponse struct {
	*DescribeNodeAssociationStatusOutput
	// contains filtered or unexported fields
}

DescribeNodeAssociationStatusResponse is the response type for the DescribeNodeAssociationStatus API operation.

func (*DescribeNodeAssociationStatusResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeNodeAssociationStatusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeNodeAssociationStatus request.

type DescribeServersInput 

type DescribeServersInput struct {

	// This is not currently implemented for DescribeServers requests.
	MaxResults *int64 `min:"1" type:"integer"`

	// This is not currently implemented for DescribeServers requests.
	NextToken *string `type:"string"`

	// Describes the server with the specified ServerName.
	ServerName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeServersInput) String 

func (s DescribeServersInput) String() string

String returns the string representation

func (*DescribeServersInput) Validate 

func (s *DescribeServersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeServersOutput 

type DescribeServersOutput struct {

	// This is not currently implemented for DescribeServers requests.
	NextToken *string `type:"string"`

	// Contains the response to a DescribeServers request.
	//
	// For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes
	// includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate
	// server to Chef Automate 2. To be eligible for upgrade, a server running Chef
	// Automate 1 must have had at least one successful maintenance run after November
	// 1, 2019.
	//
	// For Puppet Server: DescribeServersResponse$Servers$EngineAttributes contains
	// PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by
	// the Puppet API over TCP port number 8140. The CA certificate is also used
	// to sign node certificates.
	Servers []Server `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeServersOutput) String 

func (s DescribeServersOutput) String() string

String returns the string representation

type DescribeServersPaginator added in v0.21.0 

type DescribeServersPaginator struct {
	aws.Pager
}

DescribeServersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeServersPaginator added in v0.21.0 

func NewDescribeServersPaginator(req DescribeServersRequest) DescribeServersPaginator

NewDescribeServersRequestPaginator returns a paginator for DescribeServers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeServersRequest(input)
p := opsworkscm.NewDescribeServersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeServersPaginator) CurrentPage added in v0.21.0 

func (p *DescribeServersPaginator) CurrentPage() *DescribeServersOutput

type DescribeServersRequest 

type DescribeServersRequest struct {
	*aws.Request
	Input *DescribeServersInput
	Copy  func(*DescribeServersInput) DescribeServersRequest
}

DescribeServersRequest is the request type for the DescribeServers API operation.

func (DescribeServersRequest) Send 

func (r DescribeServersRequest) Send(ctx context.Context) (*DescribeServersResponse, error)

Send marshals and sends the DescribeServers API request.

type DescribeServersResponse added in v0.9.0 

type DescribeServersResponse struct {
	*DescribeServersOutput
	// contains filtered or unexported fields
}

DescribeServersResponse is the response type for the DescribeServers API operation.

func (*DescribeServersResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeServersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeServers request.

type DisassociateNodeInput 

type DisassociateNodeInput struct {

	// Engine attributes that are used for disassociating the node. No attributes
	// are required for Puppet.
	//
	// Attributes required in a DisassociateNode request for Chef
	//
	//    * CHEF_ORGANIZATION: The Chef organization with which the node was associated.
	//    By default only one organization named default can exist.
	EngineAttributes []EngineAttribute `type:"list"`

	// The name of the client node.
	//
	// NodeName is a required field
	NodeName *string `type:"string" required:"true"`

	// The name of the server from which to disassociate the node.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateNodeInput) String 

func (s DisassociateNodeInput) String() string

String returns the string representation

func (*DisassociateNodeInput) Validate 

func (s *DisassociateNodeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateNodeOutput 

type DisassociateNodeOutput struct {

	// Contains a token which can be passed to the DescribeNodeAssociationStatus
	// API call to get the status of the disassociation request.
	NodeAssociationStatusToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DisassociateNodeOutput) String 

func (s DisassociateNodeOutput) String() string

String returns the string representation

type DisassociateNodeRequest 

type DisassociateNodeRequest struct {
	*aws.Request
	Input *DisassociateNodeInput
	Copy  func(*DisassociateNodeInput) DisassociateNodeRequest
}

DisassociateNodeRequest is the request type for the DisassociateNode API operation.

func (DisassociateNodeRequest) Send 

func (r DisassociateNodeRequest) Send(ctx context.Context) (*DisassociateNodeResponse, error)

Send marshals and sends the DisassociateNode API request.

type DisassociateNodeResponse added in v0.9.0 

type DisassociateNodeResponse struct {
	*DisassociateNodeOutput
	// contains filtered or unexported fields
}

DisassociateNodeResponse is the response type for the DisassociateNode API operation.

func (*DisassociateNodeResponse) SDKResponseMetdata added in v0.9.0 

func (r *DisassociateNodeResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateNode request.

type EngineAttribute 

type EngineAttribute struct {

	// The name of the engine attribute.
	Name *string `type:"string"`

	// The value of the engine attribute.
	Value *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

A name and value pair that is specific to the engine of the server.

func (EngineAttribute) String 

func (s EngineAttribute) String() string

String returns the string representation

type ExportServerEngineAttributeInput added in v0.5.0 

type ExportServerEngineAttributeInput struct {

	// The name of the export attribute. Currently, the supported export attribute
	// is Userdata. This exports a user data script that includes parameters and
	// values provided in the InputAttributes list.
	//
	// ExportAttributeName is a required field
	ExportAttributeName *string `type:"string" required:"true"`

	// The list of engine attributes. The list type is EngineAttribute. An EngineAttribute
	// list item is a pair that includes an attribute name and its value. For the
	// Userdata ExportAttributeName, the following are supported engine attribute
	// names.
	//
	//    * RunList In Chef, a list of roles or recipes that are run in the specified
	//    order. In Puppet, this parameter is ignored.
	//
	//    * OrganizationName In Chef, an organization name. AWS OpsWorks for Chef
	//    Automate always creates the organization default. In Puppet, this parameter
	//    is ignored.
	//
	//    * NodeEnvironment In Chef, a node environment (for example, development,
	//    staging, or one-box). In Puppet, this parameter is ignored.
	//
	//    * NodeClientVersion In Chef, the version of the Chef engine (three numbers
	//    separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks
	//    for Chef Automate uses the most current version. In Puppet, this parameter
	//    is ignored.
	InputAttributes []EngineAttribute `type:"list"`

	// The name of the server from which you are exporting the attribute.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExportServerEngineAttributeInput) String added in v0.5.0 

func (s ExportServerEngineAttributeInput) String() string

String returns the string representation

func (*ExportServerEngineAttributeInput) Validate added in v0.5.0 

func (s *ExportServerEngineAttributeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportServerEngineAttributeOutput added in v0.5.0 

type ExportServerEngineAttributeOutput struct {

	// The requested engine attribute pair with attribute name and value.
	EngineAttribute *EngineAttribute `type:"structure"`

	// The server name used in the request.
	ServerName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ExportServerEngineAttributeOutput) String added in v0.5.0 

func (s ExportServerEngineAttributeOutput) String() string

String returns the string representation

type ExportServerEngineAttributeRequest added in v0.5.0 

type ExportServerEngineAttributeRequest struct {
	*aws.Request
	Input *ExportServerEngineAttributeInput
	Copy  func(*ExportServerEngineAttributeInput) ExportServerEngineAttributeRequest
}

ExportServerEngineAttributeRequest is the request type for the ExportServerEngineAttribute API operation.

func (ExportServerEngineAttributeRequest) Send added in v0.5.0 

func (r ExportServerEngineAttributeRequest) Send(ctx context.Context) (*ExportServerEngineAttributeResponse, error)

Send marshals and sends the ExportServerEngineAttribute API request.

type ExportServerEngineAttributeResponse added in v0.9.0 

type ExportServerEngineAttributeResponse struct {
	*ExportServerEngineAttributeOutput
	// contains filtered or unexported fields
}

ExportServerEngineAttributeResponse is the response type for the ExportServerEngineAttribute API operation.

func (*ExportServerEngineAttributeResponse) SDKResponseMetdata added in v0.9.0 

func (r *ExportServerEngineAttributeResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ExportServerEngineAttribute request.

type ListTagsForResourceInput added in v0.19.0 

type ListTagsForResourceInput struct {

	// To receive a paginated response, use this parameter to specify the maximum
	// number of results to be returned with a single call. If the number of available
	// results exceeds this maximum, the response includes a NextToken value that
	// you can assign to the NextToken request parameter to get the next set of
	// results.
	MaxResults *int64 `min:"1" type:"integer"`

	// NextToken is a string that is returned in some command responses. It indicates
	// that not all entries have been returned, and that you must run at least one
	// more request to get remaining items. To get remaining results, call ListTagsForResource
	// again, and assign the token from the previous results as the value of the
	// nextToken parameter. If there are no more results, the response object's
	// nextToken parameter value is null. Setting a nextToken value that was not
	// returned in your previous results causes an InvalidNextTokenException to
	// occur.
	NextToken *string `type:"string"`

	// The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or
	// AWS OpsWorks for Puppet Enterprise server for which you want to show applied
	// tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) String added in v0.19.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.19.0 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v0.19.0 

type ListTagsForResourceOutput struct {

	// A token that you can use as the value of NextToken in subsequent calls to
	// the API to show more results.
	NextToken *string `type:"string"`

	// Tags that have been applied to the resource.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) String added in v0.19.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourcePaginator added in v0.21.0 

type ListTagsForResourcePaginator struct {
	aws.Pager
}

ListTagsForResourcePaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTagsForResourcePaginator added in v0.21.0 

func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator

NewListTagsForResourceRequestPaginator returns a paginator for ListTagsForResource. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListTagsForResourceRequest(input)
p := opsworkscm.NewListTagsForResourceRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTagsForResourcePaginator) CurrentPage added in v0.21.0 

func (p *ListTagsForResourcePaginator) CurrentPage() *ListTagsForResourceOutput

type ListTagsForResourceRequest added in v0.19.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.19.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.19.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.19.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type MaintenanceStatus 

type MaintenanceStatus string
const (
	MaintenanceStatusSuccess MaintenanceStatus = "SUCCESS"
	MaintenanceStatusFailed  MaintenanceStatus = "FAILED"
)

Enum values for MaintenanceStatus

func (MaintenanceStatus) MarshalValue added in v0.3.0 

func (enum MaintenanceStatus) MarshalValue() (string, error)

func (MaintenanceStatus) MarshalValueBuf added in v0.3.0 

func (enum MaintenanceStatus) MarshalValueBuf(b []byte) ([]byte, error)

type NodeAssociationStatus 

type NodeAssociationStatus string

The status of the association or disassociation request.

Possible values:

  • SUCCESS: The association or disassociation succeeded.

  • FAILED: The association or disassociation failed.

  • IN_PROGRESS: The association or disassociation is still in progress. 

const (
	NodeAssociationStatusSuccess    NodeAssociationStatus = "SUCCESS"
	NodeAssociationStatusFailed     NodeAssociationStatus = "FAILED"
	NodeAssociationStatusInProgress NodeAssociationStatus = "IN_PROGRESS"
)

Enum values for NodeAssociationStatus

func (NodeAssociationStatus) MarshalValue added in v0.3.0 

func (enum NodeAssociationStatus) MarshalValue() (string, error)

func (NodeAssociationStatus) MarshalValueBuf added in v0.3.0 

func (enum NodeAssociationStatus) MarshalValueBuf(b []byte) ([]byte, error)

type RestoreServerInput 

type RestoreServerInput struct {

	// The ID of the backup that you want to use to restore a server.
	//
	// BackupId is a required field
	BackupId *string `type:"string" required:"true"`

	// The type of instance to restore. Valid values must be specified in the following
	// format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large,
	// r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer
	// uses the instance type from the specified backup.
	InstanceType *string `type:"string"`

	// The name of the key pair to set on the new EC2 instance. This can be helpful
	// if the administrator no longer has the SSH key.
	KeyPair *string `type:"string"`

	// The name of the server that you want to restore.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreServerInput) String 

func (s RestoreServerInput) String() string

String returns the string representation

func (*RestoreServerInput) Validate 

func (s *RestoreServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreServerOutput 

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

func (RestoreServerOutput) String 

func (s RestoreServerOutput) String() string

String returns the string representation

type RestoreServerRequest 

type RestoreServerRequest struct {
	*aws.Request
	Input *RestoreServerInput
	Copy  func(*RestoreServerInput) RestoreServerRequest
}

RestoreServerRequest is the request type for the RestoreServer API operation.

func (RestoreServerRequest) Send 

func (r RestoreServerRequest) Send(ctx context.Context) (*RestoreServerResponse, error)

Send marshals and sends the RestoreServer API request.

type RestoreServerResponse added in v0.9.0 

type RestoreServerResponse struct {
	*RestoreServerOutput
	// contains filtered or unexported fields
}

RestoreServerResponse is the response type for the RestoreServer API operation.

func (*RestoreServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *RestoreServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RestoreServer request.

type Server 

type Server struct {

	// Associate a public IP address with a server that you are launching.
	AssociatePublicIpAddress *bool `type:"boolean"`

	// The number of automated backups to keep.
	BackupRetentionCount *int64 `type:"integer"`

	// The ARN of the CloudFormation stack that was used to create the server.
	CloudFormationStackArn *string `type:"string"`

	// Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
	CreatedAt *time.Time `type:"timestamp"`

	// An optional public endpoint of a server, such as https://aws.my-company.com.
	// You cannot access the server by using the Endpoint value if the server has
	// a CustomDomain specified.
	CustomDomain *string `type:"string"`

	// Disables automated backups. The number of stored backups is dependent on
	// the value of PreferredBackupCount.
	DisableAutomatedBackup *bool `type:"boolean"`

	// A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io.
	// You cannot access the server by using the Endpoint value if the server has
	// a CustomDomain specified.
	Endpoint *string `type:"string"`

	// The engine type of the server. Valid values in this release include ChefAutomate
	// and Puppet.
	Engine *string `type:"string"`

	// The response of a createServer() request returns the master credential to
	// access the server in EngineAttributes. These credentials are not stored by
	// AWS OpsWorks CM; they are returned only as part of the result of createServer().
	//
	// Attributes returned in a createServer response for Chef
	//
	//    * CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is
	//    generated by AWS OpsWorks for Chef Automate. This private key is required
	//    to access the Chef API.
	//
	//    * CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a
	//    Chef starter kit, which includes a README, a configuration file, and the
	//    required RSA private key. Save this file, unzip it, and then change to
	//    the directory where you've unzipped the file contents. From this directory,
	//    you can run Knife commands.
	//
	// Attributes returned in a createServer response for Puppet
	//
	//    * PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains
	//    a Puppet starter kit, including a README and a required private key. Save
	//    this file, unzip it, and then change to the directory where you've unzipped
	//    the file contents.
	//
	//    * PUPPET_ADMIN_PASSWORD: An administrator password that you can use to
	//    sign in to the Puppet Enterprise console after the server is online.
	EngineAttributes []EngineAttribute `type:"list"`

	// The engine model of the server. Valid values in this release include Monolithic
	// for Puppet and Single for Chef.
	EngineModel *string `type:"string"`

	// The engine version of the server. For a Chef server, the valid value for
	// EngineVersion is currently 12. For a Puppet server, the valid value is 2017.
	EngineVersion *string `type:"string"`

	// The instance profile ARN of the server.
	InstanceProfileArn *string `type:"string"`

	// The instance type for the server, as specified in the CloudFormation stack.
	// This might not be the same instance type that is shown in the EC2 console.
	InstanceType *string `type:"string"`

	// The key pair associated with the server.
	KeyPair *string `type:"string"`

	// The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
	MaintenanceStatus MaintenanceStatus `type:"string" enum:"true"`

	// The preferred backup period specified for the server.
	PreferredBackupWindow *string `type:"string"`

	// The preferred maintenance period specified for the server.
	PreferredMaintenanceWindow *string `type:"string"`

	// The security group IDs for the server, as specified in the CloudFormation
	// stack. These might not be the same security groups that are shown in the
	// EC2 console.
	SecurityGroupIds []string `type:"list"`

	// The ARN of the server.
	ServerArn *string `type:"string"`

	// The name of the server.
	ServerName *string `type:"string"`

	// The service role ARN used to create the server.
	ServiceRoleArn *string `type:"string"`

	// The server's status. This field displays the states of actions in progress,
	// such as creating, running, or backing up the server, as well as the server's
	// health state.
	Status ServerStatus `type:"string" enum:"true"`

	// Depending on the server status, this field has either a human-readable message
	// (such as a create or backup error), or an escaped block of JSON (used for
	// health check results).
	StatusReason *string `type:"string"`

	// The subnet IDs specified in a CreateServer request.
	SubnetIds []string `type:"list"`
	// contains filtered or unexported fields
}

Describes a configuration management server.

func (Server) String 

func (s Server) String() string

String returns the string representation

type ServerEvent 

type ServerEvent struct {

	// The time when the event occurred.
	CreatedAt *time.Time `type:"timestamp"`

	// The Amazon S3 URL of the event's log file.
	LogUrl *string `type:"string"`

	// A human-readable informational or status message.
	Message *string `type:"string"`

	// The name of the server on or for which the event occurred.
	ServerName *string `type:"string"`
	// contains filtered or unexported fields
}

An event that is related to the server, such as the start of maintenance or backup.

func (ServerEvent) String 

func (s ServerEvent) String() string

String returns the string representation

type ServerStatus 

type ServerStatus string
const (
	ServerStatusBackingUp        ServerStatus = "BACKING_UP"
	ServerStatusConnectionLost   ServerStatus = "CONNECTION_LOST"
	ServerStatusCreating         ServerStatus = "CREATING"
	ServerStatusDeleting         ServerStatus = "DELETING"
	ServerStatusModifying        ServerStatus = "MODIFYING"
	ServerStatusFailed           ServerStatus = "FAILED"
	ServerStatusHealthy          ServerStatus = "HEALTHY"
	ServerStatusRunning          ServerStatus = "RUNNING"
	ServerStatusRestoring        ServerStatus = "RESTORING"
	ServerStatusSetup            ServerStatus = "SETUP"
	ServerStatusUnderMaintenance ServerStatus = "UNDER_MAINTENANCE"
	ServerStatusUnhealthy        ServerStatus = "UNHEALTHY"
	ServerStatusTerminated       ServerStatus = "TERMINATED"
)

Enum values for ServerStatus

func (ServerStatus) MarshalValue added in v0.3.0 

func (enum ServerStatus) MarshalValue() (string, error)

func (ServerStatus) MarshalValueBuf added in v0.3.0 

func (enum ServerStatus) MarshalValueBuf(b []byte) ([]byte, error)

type StartMaintenanceInput 

type StartMaintenanceInput struct {

	// Engine attributes that are specific to the server on which you want to run
	// maintenance.
	//
	// Attributes accepted in a StartMaintenance request for Chef
	//
	//    * CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade
	//    to Chef Automate 2, add this engine attribute to a StartMaintenance request
	//    and set the value to true to upgrade the server to Chef Automate 2. For
	//    more information, see Upgrade an AWS OpsWorks for Chef Automate Server
	//    to Chef Automate 2 (https://docs.aws.amazon.com/opsworks/latest/userguide/opscm-a2upgrade.html).
	EngineAttributes []EngineAttribute `type:"list"`

	// The name of the server on which to run maintenance.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartMaintenanceInput) String 

func (s StartMaintenanceInput) String() string

String returns the string representation

func (*StartMaintenanceInput) Validate 

func (s *StartMaintenanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartMaintenanceOutput 

type StartMaintenanceOutput struct {

	// Contains the response to a StartMaintenance request.
	Server *Server `type:"structure"`
	// contains filtered or unexported fields
}

func (StartMaintenanceOutput) String 

func (s StartMaintenanceOutput) String() string

String returns the string representation

type StartMaintenanceRequest 

type StartMaintenanceRequest struct {
	*aws.Request
	Input *StartMaintenanceInput
	Copy  func(*StartMaintenanceInput) StartMaintenanceRequest
}

StartMaintenanceRequest is the request type for the StartMaintenance API operation.

func (StartMaintenanceRequest) Send 

func (r StartMaintenanceRequest) Send(ctx context.Context) (*StartMaintenanceResponse, error)

Send marshals and sends the StartMaintenance API request.

type StartMaintenanceResponse added in v0.9.0 

type StartMaintenanceResponse struct {
	*StartMaintenanceOutput
	// contains filtered or unexported fields
}

StartMaintenanceResponse is the response type for the StartMaintenance API operation.

func (*StartMaintenanceResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartMaintenanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartMaintenance request.

type Tag added in v0.19.0 

type Tag struct {

	// A tag key, such as Stage or Name. A tag key cannot be empty. The key can
	// be a maximum of 127 characters, and can contain only Unicode letters, numbers,
	// or separators, or the following special characters: + - = . _ : /
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// An optional tag value, such as Production or test-owcm-server. The value
	// can be a maximum of 255 characters, and contain only Unicode letters, numbers,
	// or separators, or the following special characters: + - = . _ : /
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.

func (Tag) String added in v0.19.0 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v0.19.0 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v0.19.0 

type TagResourceInput struct {

	// The Amazon Resource Number (ARN) of a resource to which you want to apply
	// tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// A map that contains tag keys and tag values to attach to AWS OpsWorks-CM
	// servers or backups.
	//
	//    * The key cannot be empty.
	//
	//    * The key can be a maximum of 127 characters, and can contain only Unicode
	//    letters, numbers, or separators, or the following special characters:
	//    + - = . _ : /
	//
	//    * The value can be a maximum 255 characters, and contain only Unicode
	//    letters, numbers, or separators, or the following special characters:
	//    + - = . _ : /
	//
	//    * Leading and trailing white spaces are trimmed from both the key and
	//    value.
	//
	//    * A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM
	//    server or backup.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) String added in v0.19.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.19.0 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v0.19.0 

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

func (TagResourceOutput) String added in v0.19.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.19.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.19.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.19.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.19.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput added in v0.19.0 

type UntagResourceInput struct {

	// The Amazon Resource Number (ARN) of a resource from which you want to remove
	// tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The keys of tags that you want to remove.
	//
	// TagKeys is a required field
	TagKeys []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) String added in v0.19.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.19.0 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v0.19.0 

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

func (UntagResourceOutput) String added in v0.19.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.19.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.19.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.19.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.19.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateServerEngineAttributesInput 

type UpdateServerEngineAttributesInput struct {

	// The name of the engine attribute to update.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// The value to set for the attribute.
	AttributeValue *string `type:"string"`

	// The name of the server to update.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateServerEngineAttributesInput) String 

func (s UpdateServerEngineAttributesInput) String() string

String returns the string representation

func (*UpdateServerEngineAttributesInput) Validate 

func (s *UpdateServerEngineAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateServerEngineAttributesOutput 

type UpdateServerEngineAttributesOutput struct {

	// Contains the response to an UpdateServerEngineAttributes request.
	Server *Server `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateServerEngineAttributesOutput) String 

func (s UpdateServerEngineAttributesOutput) String() string

String returns the string representation

type UpdateServerEngineAttributesRequest 

type UpdateServerEngineAttributesRequest struct {
	*aws.Request
	Input *UpdateServerEngineAttributesInput
	Copy  func(*UpdateServerEngineAttributesInput) UpdateServerEngineAttributesRequest
}

UpdateServerEngineAttributesRequest is the request type for the UpdateServerEngineAttributes API operation.

func (UpdateServerEngineAttributesRequest) Send 

func (r UpdateServerEngineAttributesRequest) Send(ctx context.Context) (*UpdateServerEngineAttributesResponse, error)

Send marshals and sends the UpdateServerEngineAttributes API request.

type UpdateServerEngineAttributesResponse added in v0.9.0 

type UpdateServerEngineAttributesResponse struct {
	*UpdateServerEngineAttributesOutput
	// contains filtered or unexported fields
}

UpdateServerEngineAttributesResponse is the response type for the UpdateServerEngineAttributes API operation.

func (*UpdateServerEngineAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateServerEngineAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateServerEngineAttributes request.

type UpdateServerInput 

type UpdateServerInput struct {

	// Sets the number of automated backups that you want to keep.
	BackupRetentionCount *int64 `type:"integer"`

	// Setting DisableAutomatedBackup to true disables automated or scheduled backups.
	// Automated backups are enabled by default.
	DisableAutomatedBackup *bool `type:"boolean"`

	// DDD:HH:MM (weekly start time) or HH:MM (daily start time).
	//
	// Time windows always use coordinated universal time (UTC). Valid strings for
	// day of week (DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, or Sun.
	PreferredBackupWindow *string `type:"string"`

	// DDD:HH:MM (weekly start time) or HH:MM (daily start time).
	//
	// Time windows always use coordinated universal time (UTC). Valid strings for
	// day of week (DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, or Sun.
	PreferredMaintenanceWindow *string `type:"string"`

	// The name of the server to update.
	//
	// ServerName is a required field
	ServerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateServerInput) String 

func (s UpdateServerInput) String() string

String returns the string representation

func (*UpdateServerInput) Validate 

func (s *UpdateServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateServerOutput 

type UpdateServerOutput struct {

	// Contains the response to a UpdateServer request.
	Server *Server `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateServerOutput) String 

func (s UpdateServerOutput) String() string

String returns the string representation

type UpdateServerRequest 

type UpdateServerRequest struct {
	*aws.Request
	Input *UpdateServerInput
	Copy  func(*UpdateServerInput) UpdateServerRequest
}

UpdateServerRequest is the request type for the UpdateServer API operation.

func (UpdateServerRequest) Send 

func (r UpdateServerRequest) Send(ctx context.Context) (*UpdateServerResponse, error)

Send marshals and sends the UpdateServer API request.

type UpdateServerResponse added in v0.9.0 

type UpdateServerResponse struct {
	*UpdateServerOutput
	// contains filtered or unexported fields
}

UpdateServerResponse is the response type for the UpdateServer API operation.

func (*UpdateServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateServer request.

Source Files

View all Source files

Directories

Path Synopsis
Package opsworkscmiface provides an interface to enable mocking the AWS OpsWorks CM service client for testing your code.
 Package opsworkscmiface provides an interface to enable mocking the AWS OpsWorks CM service client for testing your code.

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.