opsworkscm

package
v0.0.0-...-d87692f Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2024 License: Apache-2.0, Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package opsworkscm provides the client and types for making API requests to AWS OpsWorks CM.

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

For more information, see AWS OpsWorks endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html) in the AWS General Reference.

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 contact AWS OpsWorks CM 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 AWS OpsWorks CM client OpsWorksCM 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 (
	// BackupStatusInProgress is a BackupStatus enum value
	BackupStatusInProgress = "IN_PROGRESS"

	// BackupStatusOk is a BackupStatus enum value
	BackupStatusOk = "OK"

	// BackupStatusFailed is a BackupStatus enum value
	BackupStatusFailed = "FAILED"

	// BackupStatusDeleting is a BackupStatus enum value
	BackupStatusDeleting = "DELETING"
)
View Source 
const (
	// BackupTypeAutomated is a BackupType enum value
	BackupTypeAutomated = "AUTOMATED"

	// BackupTypeManual is a BackupType enum value
	BackupTypeManual = "MANUAL"
)
View Source 
const (
	// MaintenanceStatusSuccess is a MaintenanceStatus enum value
	MaintenanceStatusSuccess = "SUCCESS"

	// MaintenanceStatusFailed is a MaintenanceStatus enum value
	MaintenanceStatusFailed = "FAILED"
)
View Source 
const (
	// NodeAssociationStatusSuccess is a NodeAssociationStatus enum value
	NodeAssociationStatusSuccess = "SUCCESS"

	// NodeAssociationStatusFailed is a NodeAssociationStatus enum value
	NodeAssociationStatusFailed = "FAILED"

	// NodeAssociationStatusInProgress is a NodeAssociationStatus enum value
	NodeAssociationStatusInProgress = "IN_PROGRESS"
)

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.

View Source 
const (
	// ServerStatusBackingUp is a ServerStatus enum value
	ServerStatusBackingUp = "BACKING_UP"

	// ServerStatusConnectionLost is a ServerStatus enum value
	ServerStatusConnectionLost = "CONNECTION_LOST"

	// ServerStatusCreating is a ServerStatus enum value
	ServerStatusCreating = "CREATING"

	// ServerStatusDeleting is a ServerStatus enum value
	ServerStatusDeleting = "DELETING"

	// ServerStatusModifying is a ServerStatus enum value
	ServerStatusModifying = "MODIFYING"

	// ServerStatusFailed is a ServerStatus enum value
	ServerStatusFailed = "FAILED"

	// ServerStatusHealthy is a ServerStatus enum value
	ServerStatusHealthy = "HEALTHY"

	// ServerStatusRunning is a ServerStatus enum value
	ServerStatusRunning = "RUNNING"

	// ServerStatusRestoring is a ServerStatus enum value
	ServerStatusRestoring = "RESTORING"

	// ServerStatusSetup is a ServerStatus enum value
	ServerStatusSetup = "SETUP"

	// ServerStatusUnderMaintenance is a ServerStatus enum value
	ServerStatusUnderMaintenance = "UNDER_MAINTENANCE"

	// ServerStatusUnhealthy is a ServerStatus enum value
	ServerStatusUnhealthy = "UNHEALTHY"

	// ServerStatusTerminated is a ServerStatus enum value
	ServerStatusTerminated = "TERMINATED"
)
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"
)
View Source 
const (
	ServiceName = "opsworks-cm" // Name of service.
	EndpointsID = ServiceName   // ID to lookup a service endpoint with.
	ServiceID   = "OpsWorksCM"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func BackupStatus_Values 

func BackupStatus_Values() []string

BackupStatus_Values returns all elements of the BackupStatus enum

func BackupType_Values 

func BackupType_Values() []string

BackupType_Values returns all elements of the BackupType enum

func MaintenanceStatus_Values 

func MaintenanceStatus_Values() []string

MaintenanceStatus_Values returns all elements of the MaintenanceStatus enum

func NodeAssociationStatus_Values 

func NodeAssociationStatus_Values() []string

NodeAssociationStatus_Values returns all elements of the NodeAssociationStatus enum

func ServerStatus_Values 

func ServerStatus_Values() []string

ServerStatus_Values returns all elements of the ServerStatus enum

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) GoString 

func (s AccountAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountAttribute) SetMaximum 

func (s *AccountAttribute) SetMaximum(v int64) *AccountAttribute

SetMaximum sets the Maximum field's value.

func (*AccountAttribute) SetName 

func (s *AccountAttribute) SetName(v string) *AccountAttribute

SetName sets the Name field's value.

func (*AccountAttribute) SetUsed 

func (s *AccountAttribute) SetUsed(v int64) *AccountAttribute

SetUsed sets the Used field's value.

func (AccountAttribute) String 

func (s AccountAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s AssociateNodeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateNodeInput) SetEngineAttributes 

func (s *AssociateNodeInput) SetEngineAttributes(v []*EngineAttribute) *AssociateNodeInput

SetEngineAttributes sets the EngineAttributes field's value.

func (*AssociateNodeInput) SetNodeName 

func (s *AssociateNodeInput) SetNodeName(v string) *AssociateNodeInput

SetNodeName sets the NodeName field's value.

func (*AssociateNodeInput) SetServerName 

func (s *AssociateNodeInput) SetServerName(v string) *AssociateNodeInput

SetServerName sets the ServerName field's value.

func (AssociateNodeInput) String 

func (s AssociateNodeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s AssociateNodeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateNodeOutput) SetNodeAssociationStatusToken 

func (s *AssociateNodeOutput) SetNodeAssociationStatusToken(v string) *AssociateNodeOutput

SetNodeAssociationStatusToken sets the NodeAssociationStatusToken field's value.

func (AssociateNodeOutput) String 

func (s AssociateNodeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"BackupType"`

	// 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.
	//
	// Deprecated: S3DataSize has been deprecated
	S3DataSize *int64 `deprecated:"true" type:"integer"`

	// This field is deprecated and is no longer used.
	//
	// Deprecated: S3DataUrl has been deprecated
	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 *string `type:"string" enum:"BackupStatus"`

	// 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) GoString 

func (s Backup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Backup) SetBackupArn 

func (s *Backup) SetBackupArn(v string) *Backup

SetBackupArn sets the BackupArn field's value.

func (*Backup) SetBackupId 

func (s *Backup) SetBackupId(v string) *Backup

SetBackupId sets the BackupId field's value.

func (*Backup) SetBackupType 

func (s *Backup) SetBackupType(v string) *Backup

SetBackupType sets the BackupType field's value.

func (*Backup) SetCreatedAt 

func (s *Backup) SetCreatedAt(v time.Time) *Backup

SetCreatedAt sets the CreatedAt field's value.

func (*Backup) SetDescription 

func (s *Backup) SetDescription(v string) *Backup

SetDescription sets the Description field's value.

func (*Backup) SetEngine 

func (s *Backup) SetEngine(v string) *Backup

SetEngine sets the Engine field's value.

func (*Backup) SetEngineModel 

func (s *Backup) SetEngineModel(v string) *Backup

SetEngineModel sets the EngineModel field's value.

func (*Backup) SetEngineVersion 

func (s *Backup) SetEngineVersion(v string) *Backup

SetEngineVersion sets the EngineVersion field's value.

func (*Backup) SetInstanceProfileArn 

func (s *Backup) SetInstanceProfileArn(v string) *Backup

SetInstanceProfileArn sets the InstanceProfileArn field's value.

func (*Backup) SetInstanceType 

func (s *Backup) SetInstanceType(v string) *Backup

SetInstanceType sets the InstanceType field's value.

func (*Backup) SetKeyPair 

func (s *Backup) SetKeyPair(v string) *Backup

SetKeyPair sets the KeyPair field's value.

func (*Backup) SetPreferredBackupWindow 

func (s *Backup) SetPreferredBackupWindow(v string) *Backup

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*Backup) SetPreferredMaintenanceWindow 

func (s *Backup) SetPreferredMaintenanceWindow(v string) *Backup

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*Backup) SetS3DataSize 

func (s *Backup) SetS3DataSize(v int64) *Backup

SetS3DataSize sets the S3DataSize field's value.

func (*Backup) SetS3DataUrl 

func (s *Backup) SetS3DataUrl(v string) *Backup

SetS3DataUrl sets the S3DataUrl field's value.

func (*Backup) SetS3LogUrl 

func (s *Backup) SetS3LogUrl(v string) *Backup

SetS3LogUrl sets the S3LogUrl field's value.

func (*Backup) SetSecurityGroupIds 

func (s *Backup) SetSecurityGroupIds(v []*string) *Backup

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*Backup) SetServerName 

func (s *Backup) SetServerName(v string) *Backup

SetServerName sets the ServerName field's value.

func (*Backup) SetServiceRoleArn 

func (s *Backup) SetServiceRoleArn(v string) *Backup

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*Backup) SetStatus 

func (s *Backup) SetStatus(v string) *Backup

SetStatus sets the Status field's value.

func (*Backup) SetStatusDescription 

func (s *Backup) SetStatusDescription(v string) *Backup

SetStatusDescription sets the StatusDescription field's value.

func (*Backup) SetSubnetIds 

func (s *Backup) SetSubnetIds(v []*string) *Backup

SetSubnetIds sets the SubnetIds field's value.

func (*Backup) SetToolsVersion 

func (s *Backup) SetToolsVersion(v string) *Backup

SetToolsVersion sets the ToolsVersion field's value.

func (*Backup) SetUserArn 

func (s *Backup) SetUserArn(v string) *Backup

SetUserArn sets the UserArn field's value.

func (Backup) String 

func (s Backup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s CreateBackupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBackupInput) SetDescription 

func (s *CreateBackupInput) SetDescription(v string) *CreateBackupInput

SetDescription sets the Description field's value.

func (*CreateBackupInput) SetServerName 

func (s *CreateBackupInput) SetServerName(v string) *CreateBackupInput

SetServerName sets the ServerName field's value.

func (*CreateBackupInput) SetTags 

func (s *CreateBackupInput) SetTags(v []*Tag) *CreateBackupInput

SetTags sets the Tags field's value.

func (CreateBackupInput) String 

func (s CreateBackupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s CreateBackupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBackupOutput) SetBackup 

func (s *CreateBackupOutput) SetBackup(v *Backup) *CreateBackupOutput

SetBackup sets the Backup field's value.

func (CreateBackupOutput) String 

func (s CreateBackupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateServerInput's
	// String and GoString methods.
	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 is a required field
	Engine *string `type:"string" required:"true"`

	// 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 2. For a Puppet server,
	// valid values are 2019 or 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
	//
	// MM must be specified as 00. 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. MM must be specified as 00. 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) GoString 

func (s CreateServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateServerInput) SetAssociatePublicIpAddress 

func (s *CreateServerInput) SetAssociatePublicIpAddress(v bool) *CreateServerInput

SetAssociatePublicIpAddress sets the AssociatePublicIpAddress field's value.

func (*CreateServerInput) SetBackupId 

func (s *CreateServerInput) SetBackupId(v string) *CreateServerInput

SetBackupId sets the BackupId field's value.

func (*CreateServerInput) SetBackupRetentionCount 

func (s *CreateServerInput) SetBackupRetentionCount(v int64) *CreateServerInput

SetBackupRetentionCount sets the BackupRetentionCount field's value.

func (*CreateServerInput) SetCustomCertificate 

func (s *CreateServerInput) SetCustomCertificate(v string) *CreateServerInput

SetCustomCertificate sets the CustomCertificate field's value.

func (*CreateServerInput) SetCustomDomain 

func (s *CreateServerInput) SetCustomDomain(v string) *CreateServerInput

SetCustomDomain sets the CustomDomain field's value.

func (*CreateServerInput) SetCustomPrivateKey 

func (s *CreateServerInput) SetCustomPrivateKey(v string) *CreateServerInput

SetCustomPrivateKey sets the CustomPrivateKey field's value.

func (*CreateServerInput) SetDisableAutomatedBackup 

func (s *CreateServerInput) SetDisableAutomatedBackup(v bool) *CreateServerInput

SetDisableAutomatedBackup sets the DisableAutomatedBackup field's value.

func (*CreateServerInput) SetEngine 

func (s *CreateServerInput) SetEngine(v string) *CreateServerInput

SetEngine sets the Engine field's value.

func (*CreateServerInput) SetEngineAttributes 

func (s *CreateServerInput) SetEngineAttributes(v []*EngineAttribute) *CreateServerInput

SetEngineAttributes sets the EngineAttributes field's value.

func (*CreateServerInput) SetEngineModel 

func (s *CreateServerInput) SetEngineModel(v string) *CreateServerInput

SetEngineModel sets the EngineModel field's value.

func (*CreateServerInput) SetEngineVersion 

func (s *CreateServerInput) SetEngineVersion(v string) *CreateServerInput

SetEngineVersion sets the EngineVersion field's value.

func (*CreateServerInput) SetInstanceProfileArn 

func (s *CreateServerInput) SetInstanceProfileArn(v string) *CreateServerInput

SetInstanceProfileArn sets the InstanceProfileArn field's value.

func (*CreateServerInput) SetInstanceType 

func (s *CreateServerInput) SetInstanceType(v string) *CreateServerInput

SetInstanceType sets the InstanceType field's value.

func (*CreateServerInput) SetKeyPair 

func (s *CreateServerInput) SetKeyPair(v string) *CreateServerInput

SetKeyPair sets the KeyPair field's value.

func (*CreateServerInput) SetPreferredBackupWindow 

func (s *CreateServerInput) SetPreferredBackupWindow(v string) *CreateServerInput

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*CreateServerInput) SetPreferredMaintenanceWindow 

func (s *CreateServerInput) SetPreferredMaintenanceWindow(v string) *CreateServerInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateServerInput) SetSecurityGroupIds 

func (s *CreateServerInput) SetSecurityGroupIds(v []*string) *CreateServerInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateServerInput) SetServerName 

func (s *CreateServerInput) SetServerName(v string) *CreateServerInput

SetServerName sets the ServerName field's value.

func (*CreateServerInput) SetServiceRoleArn 

func (s *CreateServerInput) SetServiceRoleArn(v string) *CreateServerInput

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*CreateServerInput) SetSubnetIds 

func (s *CreateServerInput) SetSubnetIds(v []*string) *CreateServerInput

SetSubnetIds sets the SubnetIds field's value.

func (*CreateServerInput) SetTags 

func (s *CreateServerInput) SetTags(v []*Tag) *CreateServerInput

SetTags sets the Tags field's value.

func (CreateServerInput) String 

func (s CreateServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s CreateServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateServerOutput) SetServer 

func (s *CreateServerOutput) SetServer(v *Server) *CreateServerOutput

SetServer sets the Server field's value.

func (CreateServerOutput) String 

func (s CreateServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DeleteBackupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBackupInput) SetBackupId 

func (s *DeleteBackupInput) SetBackupId(v string) *DeleteBackupInput

SetBackupId sets the BackupId field's value.

func (DeleteBackupInput) String 

func (s DeleteBackupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DeleteBackupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteBackupOutput) String 

func (s DeleteBackupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DeleteServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteServerInput) SetServerName 

func (s *DeleteServerInput) SetServerName(v string) *DeleteServerInput

SetServerName sets the ServerName field's value.

func (DeleteServerInput) String 

func (s DeleteServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DeleteServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteServerOutput) String 

func (s DeleteServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountAttributesInput 

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

func (DescribeAccountAttributesInput) GoString 

func (s DescribeAccountAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeAccountAttributesInput) String 

func (s DescribeAccountAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DescribeAccountAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountAttributesOutput) SetAttributes 

func (s *DescribeAccountAttributesOutput) SetAttributes(v []*AccountAttribute) *DescribeAccountAttributesOutput

SetAttributes sets the Attributes field's value.

func (DescribeAccountAttributesOutput) String 

func (s DescribeAccountAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DescribeBackupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBackupsInput) SetBackupId 

func (s *DescribeBackupsInput) SetBackupId(v string) *DescribeBackupsInput

SetBackupId sets the BackupId field's value.

func (*DescribeBackupsInput) SetMaxResults 

func (s *DescribeBackupsInput) SetMaxResults(v int64) *DescribeBackupsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeBackupsInput) SetNextToken 

func (s *DescribeBackupsInput) SetNextToken(v string) *DescribeBackupsInput

SetNextToken sets the NextToken field's value.

func (*DescribeBackupsInput) SetServerName 

func (s *DescribeBackupsInput) SetServerName(v string) *DescribeBackupsInput

SetServerName sets the ServerName field's value.

func (DescribeBackupsInput) String 

func (s DescribeBackupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DescribeBackupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBackupsOutput) SetBackups 

func (s *DescribeBackupsOutput) SetBackups(v []*Backup) *DescribeBackupsOutput

SetBackups sets the Backups field's value.

func (*DescribeBackupsOutput) SetNextToken 

func (s *DescribeBackupsOutput) SetNextToken(v string) *DescribeBackupsOutput

SetNextToken sets the NextToken field's value.

func (DescribeBackupsOutput) String 

func (s DescribeBackupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DescribeEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsInput) SetMaxResults 

func (s *DescribeEventsInput) SetMaxResults(v int64) *DescribeEventsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeEventsInput) SetNextToken 

func (s *DescribeEventsInput) SetNextToken(v string) *DescribeEventsInput

SetNextToken sets the NextToken field's value.

func (*DescribeEventsInput) SetServerName 

func (s *DescribeEventsInput) SetServerName(v string) *DescribeEventsInput

SetServerName sets the ServerName field's value.

func (DescribeEventsInput) String 

func (s DescribeEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DescribeEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsOutput) SetNextToken 

func (s *DescribeEventsOutput) SetNextToken(v string) *DescribeEventsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeEventsOutput) SetServerEvents 

func (s *DescribeEventsOutput) SetServerEvents(v []*ServerEvent) *DescribeEventsOutput

SetServerEvents sets the ServerEvents field's value.

func (DescribeEventsOutput) String 

func (s DescribeEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DescribeNodeAssociationStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNodeAssociationStatusInput) SetNodeAssociationStatusToken 

func (s *DescribeNodeAssociationStatusInput) SetNodeAssociationStatusToken(v string) *DescribeNodeAssociationStatusInput

SetNodeAssociationStatusToken sets the NodeAssociationStatusToken field's value.

func (*DescribeNodeAssociationStatusInput) SetServerName 

func (s *DescribeNodeAssociationStatusInput) SetServerName(v string) *DescribeNodeAssociationStatusInput

SetServerName sets the ServerName field's value.

func (DescribeNodeAssociationStatusInput) String 

func (s DescribeNodeAssociationStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"NodeAssociationStatus"`
	// contains filtered or unexported fields
}

func (DescribeNodeAssociationStatusOutput) GoString 

func (s DescribeNodeAssociationStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNodeAssociationStatusOutput) SetEngineAttributes 

func (s *DescribeNodeAssociationStatusOutput) SetEngineAttributes(v []*EngineAttribute) *DescribeNodeAssociationStatusOutput

SetEngineAttributes sets the EngineAttributes field's value.

func (*DescribeNodeAssociationStatusOutput) SetNodeAssociationStatus 

func (s *DescribeNodeAssociationStatusOutput) SetNodeAssociationStatus(v string) *DescribeNodeAssociationStatusOutput

SetNodeAssociationStatus sets the NodeAssociationStatus field's value.

func (DescribeNodeAssociationStatusOutput) String 

func (s DescribeNodeAssociationStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DescribeServersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServersInput) SetMaxResults 

func (s *DescribeServersInput) SetMaxResults(v int64) *DescribeServersInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeServersInput) SetNextToken 

func (s *DescribeServersInput) SetNextToken(v string) *DescribeServersInput

SetNextToken sets the NextToken field's value.

func (*DescribeServersInput) SetServerName 

func (s *DescribeServersInput) SetServerName(v string) *DescribeServersInput

SetServerName sets the ServerName field's value.

func (DescribeServersInput) String 

func (s DescribeServersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 servers: DescribeServersResponse$Servers$EngineAttributes contains
	// the following two responses:
	//
	//    * PUPPET_API_CA_CERT, 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.
	//
	//    * PUPPET_API_CRL, a certificate revocation list. The certificate revocation
	//    list is for internal maintenance purposes only. For more information about
	//    the Puppet certificate revocation list, see Man Page: puppet certificate_revocation_list
	//    (https://puppet.com/docs/puppet/5.5/man/certificate_revocation_list.html)
	//    in the Puppet documentation.
	Servers []*Server `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeServersOutput) GoString 

func (s DescribeServersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServersOutput) SetNextToken 

func (s *DescribeServersOutput) SetNextToken(v string) *DescribeServersOutput

SetNextToken sets the NextToken field's value.

func (*DescribeServersOutput) SetServers 

func (s *DescribeServersOutput) SetServers(v []*Server) *DescribeServersOutput

SetServers sets the Servers field's value.

func (DescribeServersOutput) String 

func (s DescribeServersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DisassociateNodeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateNodeInput) SetEngineAttributes 

func (s *DisassociateNodeInput) SetEngineAttributes(v []*EngineAttribute) *DisassociateNodeInput

SetEngineAttributes sets the EngineAttributes field's value.

func (*DisassociateNodeInput) SetNodeName 

func (s *DisassociateNodeInput) SetNodeName(v string) *DisassociateNodeInput

SetNodeName sets the NodeName field's value.

func (*DisassociateNodeInput) SetServerName 

func (s *DisassociateNodeInput) SetServerName(v string) *DisassociateNodeInput

SetServerName sets the ServerName field's value.

func (DisassociateNodeInput) String 

func (s DisassociateNodeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DisassociateNodeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateNodeOutput) SetNodeAssociationStatusToken 

func (s *DisassociateNodeOutput) SetNodeAssociationStatusToken(v string) *DisassociateNodeOutput

SetNodeAssociationStatusToken sets the NodeAssociationStatusToken field's value.

func (DisassociateNodeOutput) String 

func (s DisassociateNodeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EngineAttribute 

type EngineAttribute struct {

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

	// The value of the engine attribute.
	//
	// Value is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EngineAttribute's
	// String and GoString methods.
	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) GoString 

func (s EngineAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EngineAttribute) SetName 

func (s *EngineAttribute) SetName(v string) *EngineAttribute

SetName sets the Name field's value.

func (*EngineAttribute) SetValue 

func (s *EngineAttribute) SetValue(v string) *EngineAttribute

SetValue sets the Value field's value.

func (EngineAttribute) String 

func (s EngineAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportServerEngineAttributeInput 

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) GoString 

func (s ExportServerEngineAttributeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportServerEngineAttributeInput) SetExportAttributeName 

func (s *ExportServerEngineAttributeInput) SetExportAttributeName(v string) *ExportServerEngineAttributeInput

SetExportAttributeName sets the ExportAttributeName field's value.

func (*ExportServerEngineAttributeInput) SetInputAttributes 

func (s *ExportServerEngineAttributeInput) SetInputAttributes(v []*EngineAttribute) *ExportServerEngineAttributeInput

SetInputAttributes sets the InputAttributes field's value.

func (*ExportServerEngineAttributeInput) SetServerName 

func (s *ExportServerEngineAttributeInput) SetServerName(v string) *ExportServerEngineAttributeInput

SetServerName sets the ServerName field's value.

func (ExportServerEngineAttributeInput) String 

func (s ExportServerEngineAttributeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportServerEngineAttributeInput) Validate 

func (s *ExportServerEngineAttributeInput) Validate() error

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

type ExportServerEngineAttributeOutput 

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) GoString 

func (s ExportServerEngineAttributeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportServerEngineAttributeOutput) SetEngineAttribute 

func (s *ExportServerEngineAttributeOutput) SetEngineAttribute(v *EngineAttribute) *ExportServerEngineAttributeOutput

SetEngineAttribute sets the EngineAttribute field's value.

func (*ExportServerEngineAttributeOutput) SetServerName 

func (s *ExportServerEngineAttributeOutput) SetServerName(v string) *ExportServerEngineAttributeOutput

SetServerName sets the ServerName field's value.

func (ExportServerEngineAttributeOutput) String 

func (s ExportServerEngineAttributeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidNextTokenException 

type InvalidNextTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Error or informational message that can contain more detail about a nextToken
	// failure.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

This occurs when the provided nextToken is not valid.

func (*InvalidNextTokenException) Code 

func (s *InvalidNextTokenException) Code() string

Code returns the exception type name.

func (*InvalidNextTokenException) Error 

func (s *InvalidNextTokenException) Error() string

func (InvalidNextTokenException) GoString 

func (s InvalidNextTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidNextTokenException) Message 

func (s *InvalidNextTokenException) Message() string

Message returns the exception's message.

func (*InvalidNextTokenException) OrigErr 

func (s *InvalidNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNextTokenException) RequestID 

func (s *InvalidNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNextTokenException) StatusCode 

func (s *InvalidNextTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidNextTokenException) String 

func (s InvalidNextTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidStateException 

type InvalidStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Error or informational message that provides more detail if a resource is
	// in a state that is not valid for performing a specified action.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The resource is in a state that does not allow you to perform a specified action.

func (*InvalidStateException) Code 

func (s *InvalidStateException) Code() string

Code returns the exception type name.

func (*InvalidStateException) Error 

func (s *InvalidStateException) Error() string

func (InvalidStateException) GoString 

func (s InvalidStateException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidStateException) Message 

func (s *InvalidStateException) Message() string

Message returns the exception's message.

func (*InvalidStateException) OrigErr 

func (s *InvalidStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidStateException) RequestID 

func (s *InvalidStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidStateException) StatusCode 

func (s *InvalidStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidStateException) String 

func (s InvalidStateException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Error or informational message that the maximum allowed number of servers
	// or backups has been exceeded.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The limit of servers or backups has been reached.

func (*LimitExceededException) Code 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

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) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetMaxResults 

func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken 

func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

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) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetNextToken 

func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OpsWorksCM 

type OpsWorksCM struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *OpsWorksCM

New creates a new instance of the OpsWorksCM client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a OpsWorksCM client from just a session.
svc := opsworkscm.New(mySession)

// Create a OpsWorksCM client with additional configuration
svc := opsworkscm.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*OpsWorksCM) AssociateNode 

func (c *OpsWorksCM) AssociateNode(input *AssociateNodeInput) (*AssociateNodeOutput, error)

AssociateNode 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 (Puppet): 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation AssociateNode for usage and error information.

Returned Error Types:

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) AssociateNodeRequest 

func (c *OpsWorksCM) AssociateNodeRequest(input *AssociateNodeInput) (req *request.Request, output *AssociateNodeOutput)

AssociateNodeRequest generates a "aws/request.Request" representing the client's request for the AssociateNode operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateNode for more information on using the AssociateNode API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateNodeRequest method.
req, resp := client.AssociateNodeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) AssociateNodeWithContext 

func (c *OpsWorksCM) AssociateNodeWithContext(ctx aws.Context, input *AssociateNodeInput, opts ...request.Option) (*AssociateNodeOutput, error)

AssociateNodeWithContext is the same as AssociateNode with the addition of the ability to pass a context and additional request options.

See AssociateNode for details on how to use this API operation.

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.

func (*OpsWorksCM) CreateBackup 

func (c *OpsWorksCM) CreateBackup(input *CreateBackupInput) (*CreateBackupOutput, error)

CreateBackup 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation CreateBackup for usage and error information.

Returned Error Types:

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

  • LimitExceededException The limit of servers or backups has been reached.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) CreateBackupRequest 

func (c *OpsWorksCM) CreateBackupRequest(input *CreateBackupInput) (req *request.Request, output *CreateBackupOutput)

CreateBackupRequest generates a "aws/request.Request" representing the client's request for the CreateBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBackup for more information on using the CreateBackup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateBackupRequest method.
req, resp := client.CreateBackupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) CreateBackupWithContext 

func (c *OpsWorksCM) CreateBackupWithContext(ctx aws.Context, input *CreateBackupInput, opts ...request.Option) (*CreateBackupOutput, error)

CreateBackupWithContext is the same as CreateBackup with the addition of the ability to pass a context and additional request options.

See CreateBackup for details on how to use this API operation.

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.

func (*OpsWorksCM) CreateServer 

func (c *OpsWorksCM) CreateServer(input *CreateServerInput) (*CreateServerOutput, error)

CreateServer 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation CreateServer for usage and error information.

Returned Error Types:

  • LimitExceededException The limit of servers or backups has been reached.

  • ResourceAlreadyExistsException The requested resource cannot be created because it already exists.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) CreateServerRequest 

func (c *OpsWorksCM) CreateServerRequest(input *CreateServerInput) (req *request.Request, output *CreateServerOutput)

CreateServerRequest generates a "aws/request.Request" representing the client's request for the CreateServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateServer for more information on using the CreateServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateServerRequest method.
req, resp := client.CreateServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) CreateServerWithContext 

func (c *OpsWorksCM) CreateServerWithContext(ctx aws.Context, input *CreateServerInput, opts ...request.Option) (*CreateServerOutput, error)

CreateServerWithContext is the same as CreateServer with the addition of the ability to pass a context and additional request options.

See CreateServer for details on how to use this API operation.

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.

func (*OpsWorksCM) DeleteBackup 

func (c *OpsWorksCM) DeleteBackup(input *DeleteBackupInput) (*DeleteBackupOutput, error)

DeleteBackup 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation DeleteBackup for usage and error information.

Returned Error Types:

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) DeleteBackupRequest 

func (c *OpsWorksCM) DeleteBackupRequest(input *DeleteBackupInput) (req *request.Request, output *DeleteBackupOutput)

DeleteBackupRequest generates a "aws/request.Request" representing the client's request for the DeleteBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBackup for more information on using the DeleteBackup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBackupRequest method.
req, resp := client.DeleteBackupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) DeleteBackupWithContext 

func (c *OpsWorksCM) DeleteBackupWithContext(ctx aws.Context, input *DeleteBackupInput, opts ...request.Option) (*DeleteBackupOutput, error)

DeleteBackupWithContext is the same as DeleteBackup with the addition of the ability to pass a context and additional request options.

See DeleteBackup for details on how to use this API operation.

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.

func (*OpsWorksCM) DeleteServer 

func (c *OpsWorksCM) DeleteServer(input *DeleteServerInput) (*DeleteServerOutput, error)

DeleteServer 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation DeleteServer for usage and error information.

Returned Error Types:

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) DeleteServerRequest 

func (c *OpsWorksCM) DeleteServerRequest(input *DeleteServerInput) (req *request.Request, output *DeleteServerOutput)

DeleteServerRequest generates a "aws/request.Request" representing the client's request for the DeleteServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteServer for more information on using the DeleteServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteServerRequest method.
req, resp := client.DeleteServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) DeleteServerWithContext 

func (c *OpsWorksCM) DeleteServerWithContext(ctx aws.Context, input *DeleteServerInput, opts ...request.Option) (*DeleteServerOutput, error)

DeleteServerWithContext is the same as DeleteServer with the addition of the ability to pass a context and additional request options.

See DeleteServer for details on how to use this API operation.

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.

func (*OpsWorksCM) DescribeAccountAttributes 

func (c *OpsWorksCM) DescribeAccountAttributes(input *DescribeAccountAttributesInput) (*DescribeAccountAttributesOutput, error)

DescribeAccountAttributes API operation for AWS OpsWorks CM.

Describes your OpsWorks-CM account attributes.

This operation is synchronous.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation DescribeAccountAttributes for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeAccountAttributes

func (*OpsWorksCM) DescribeAccountAttributesRequest 

func (c *OpsWorksCM) DescribeAccountAttributesRequest(input *DescribeAccountAttributesInput) (req *request.Request, output *DescribeAccountAttributesOutput)

DescribeAccountAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountAttributes for more information on using the DescribeAccountAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAccountAttributesRequest method.
req, resp := client.DescribeAccountAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) DescribeAccountAttributesWithContext 

func (c *OpsWorksCM) DescribeAccountAttributesWithContext(ctx aws.Context, input *DescribeAccountAttributesInput, opts ...request.Option) (*DescribeAccountAttributesOutput, error)

DescribeAccountAttributesWithContext is the same as DescribeAccountAttributes with the addition of the ability to pass a context and additional request options.

See DescribeAccountAttributes for details on how to use this API operation.

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.

func (*OpsWorksCM) DescribeBackups 

func (c *OpsWorksCM) DescribeBackups(input *DescribeBackupsInput) (*DescribeBackupsOutput, error)

DescribeBackups 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation DescribeBackups for usage and error information.

Returned Error Types:

  • ValidationException One or more of the provided request parameters are not valid.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • InvalidNextTokenException This occurs when the provided nextToken is not valid.

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

func (*OpsWorksCM) DescribeBackupsPages 

func (c *OpsWorksCM) DescribeBackupsPages(input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool) error

DescribeBackupsPages iterates over the pages of a DescribeBackups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeBackups method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeBackups operation.
pageNum := 0
err := client.DescribeBackupsPages(params,
    func(page *opsworkscm.DescribeBackupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpsWorksCM) DescribeBackupsPagesWithContext 

func (c *OpsWorksCM) DescribeBackupsPagesWithContext(ctx aws.Context, input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool, opts ...request.Option) error

DescribeBackupsPagesWithContext same as DescribeBackupsPages except it takes a Context and allows setting request options on the pages.

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.

func (*OpsWorksCM) DescribeBackupsRequest 

func (c *OpsWorksCM) DescribeBackupsRequest(input *DescribeBackupsInput) (req *request.Request, output *DescribeBackupsOutput)

DescribeBackupsRequest generates a "aws/request.Request" representing the client's request for the DescribeBackups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBackups for more information on using the DescribeBackups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBackupsRequest method.
req, resp := client.DescribeBackupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) DescribeBackupsWithContext 

func (c *OpsWorksCM) DescribeBackupsWithContext(ctx aws.Context, input *DescribeBackupsInput, opts ...request.Option) (*DescribeBackupsOutput, error)

DescribeBackupsWithContext is the same as DescribeBackups with the addition of the ability to pass a context and additional request options.

See DescribeBackups for details on how to use this API operation.

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.

func (*OpsWorksCM) DescribeEvents 

func (c *OpsWorksCM) DescribeEvents(input *DescribeEventsInput) (*DescribeEventsOutput, error)

DescribeEvents 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation DescribeEvents for usage and error information.

Returned Error Types:

  • ValidationException One or more of the provided request parameters are not valid.

  • InvalidNextTokenException This occurs when the provided nextToken is not valid.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

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

func (*OpsWorksCM) DescribeEventsPages 

func (c *OpsWorksCM) DescribeEventsPages(input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool) error

DescribeEventsPages iterates over the pages of a DescribeEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEvents method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeEvents operation.
pageNum := 0
err := client.DescribeEventsPages(params,
    func(page *opsworkscm.DescribeEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpsWorksCM) DescribeEventsPagesWithContext 

func (c *OpsWorksCM) DescribeEventsPagesWithContext(ctx aws.Context, input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool, opts ...request.Option) error

DescribeEventsPagesWithContext same as DescribeEventsPages except it takes a Context and allows setting request options on the pages.

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.

func (*OpsWorksCM) DescribeEventsRequest 

func (c *OpsWorksCM) DescribeEventsRequest(input *DescribeEventsInput) (req *request.Request, output *DescribeEventsOutput)

DescribeEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEvents for more information on using the DescribeEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventsRequest method.
req, resp := client.DescribeEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) DescribeEventsWithContext 

func (c *OpsWorksCM) DescribeEventsWithContext(ctx aws.Context, input *DescribeEventsInput, opts ...request.Option) (*DescribeEventsOutput, error)

DescribeEventsWithContext is the same as DescribeEvents with the addition of the ability to pass a context and additional request options.

See DescribeEvents for details on how to use this API operation.

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.

func (*OpsWorksCM) DescribeNodeAssociationStatus 

func (c *OpsWorksCM) DescribeNodeAssociationStatus(input *DescribeNodeAssociationStatusInput) (*DescribeNodeAssociationStatusOutput, error)

DescribeNodeAssociationStatus 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation DescribeNodeAssociationStatus for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) DescribeNodeAssociationStatusRequest 

func (c *OpsWorksCM) DescribeNodeAssociationStatusRequest(input *DescribeNodeAssociationStatusInput) (req *request.Request, output *DescribeNodeAssociationStatusOutput)

DescribeNodeAssociationStatusRequest generates a "aws/request.Request" representing the client's request for the DescribeNodeAssociationStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeNodeAssociationStatus for more information on using the DescribeNodeAssociationStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeNodeAssociationStatusRequest method.
req, resp := client.DescribeNodeAssociationStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) DescribeNodeAssociationStatusWithContext 

func (c *OpsWorksCM) DescribeNodeAssociationStatusWithContext(ctx aws.Context, input *DescribeNodeAssociationStatusInput, opts ...request.Option) (*DescribeNodeAssociationStatusOutput, error)

DescribeNodeAssociationStatusWithContext is the same as DescribeNodeAssociationStatus with the addition of the ability to pass a context and additional request options.

See DescribeNodeAssociationStatus for details on how to use this API operation.

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.

func (*OpsWorksCM) DescribeServers 

func (c *OpsWorksCM) DescribeServers(input *DescribeServersInput) (*DescribeServersOutput, error)

DescribeServers 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation DescribeServers for usage and error information.

Returned Error Types:

  • ValidationException One or more of the provided request parameters are not valid.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • InvalidNextTokenException This occurs when the provided nextToken is not valid.

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

func (*OpsWorksCM) DescribeServersPages 

func (c *OpsWorksCM) DescribeServersPages(input *DescribeServersInput, fn func(*DescribeServersOutput, bool) bool) error

DescribeServersPages iterates over the pages of a DescribeServers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeServers method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeServers operation.
pageNum := 0
err := client.DescribeServersPages(params,
    func(page *opsworkscm.DescribeServersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpsWorksCM) DescribeServersPagesWithContext 

func (c *OpsWorksCM) DescribeServersPagesWithContext(ctx aws.Context, input *DescribeServersInput, fn func(*DescribeServersOutput, bool) bool, opts ...request.Option) error

DescribeServersPagesWithContext same as DescribeServersPages except it takes a Context and allows setting request options on the pages.

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.

func (*OpsWorksCM) DescribeServersRequest 

func (c *OpsWorksCM) DescribeServersRequest(input *DescribeServersInput) (req *request.Request, output *DescribeServersOutput)

DescribeServersRequest generates a "aws/request.Request" representing the client's request for the DescribeServers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeServers for more information on using the DescribeServers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeServersRequest method.
req, resp := client.DescribeServersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) DescribeServersWithContext 

func (c *OpsWorksCM) DescribeServersWithContext(ctx aws.Context, input *DescribeServersInput, opts ...request.Option) (*DescribeServersOutput, error)

DescribeServersWithContext is the same as DescribeServers with the addition of the ability to pass a context and additional request options.

See DescribeServers for details on how to use this API operation.

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.

func (*OpsWorksCM) DisassociateNode 

func (c *OpsWorksCM) DisassociateNode(input *DisassociateNodeInput) (*DisassociateNodeOutput, error)

DisassociateNode 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation DisassociateNode for usage and error information.

Returned Error Types:

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) DisassociateNodeRequest 

func (c *OpsWorksCM) DisassociateNodeRequest(input *DisassociateNodeInput) (req *request.Request, output *DisassociateNodeOutput)

DisassociateNodeRequest generates a "aws/request.Request" representing the client's request for the DisassociateNode operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateNode for more information on using the DisassociateNode API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateNodeRequest method.
req, resp := client.DisassociateNodeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) DisassociateNodeWithContext 

func (c *OpsWorksCM) DisassociateNodeWithContext(ctx aws.Context, input *DisassociateNodeInput, opts ...request.Option) (*DisassociateNodeOutput, error)

DisassociateNodeWithContext is the same as DisassociateNode with the addition of the ability to pass a context and additional request options.

See DisassociateNode for details on how to use this API operation.

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.

func (*OpsWorksCM) ExportServerEngineAttribute 

func (c *OpsWorksCM) ExportServerEngineAttribute(input *ExportServerEngineAttributeInput) (*ExportServerEngineAttributeOutput, error)

ExportServerEngineAttribute 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation ExportServerEngineAttribute for usage and error information.

Returned Error Types:

  • ValidationException One or more of the provided request parameters are not valid.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

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

func (*OpsWorksCM) ExportServerEngineAttributeRequest 

func (c *OpsWorksCM) ExportServerEngineAttributeRequest(input *ExportServerEngineAttributeInput) (req *request.Request, output *ExportServerEngineAttributeOutput)

ExportServerEngineAttributeRequest generates a "aws/request.Request" representing the client's request for the ExportServerEngineAttribute operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExportServerEngineAttribute for more information on using the ExportServerEngineAttribute API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ExportServerEngineAttributeRequest method.
req, resp := client.ExportServerEngineAttributeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) ExportServerEngineAttributeWithContext 

func (c *OpsWorksCM) ExportServerEngineAttributeWithContext(ctx aws.Context, input *ExportServerEngineAttributeInput, opts ...request.Option) (*ExportServerEngineAttributeOutput, error)

ExportServerEngineAttributeWithContext is the same as ExportServerEngineAttribute with the addition of the ability to pass a context and additional request options.

See ExportServerEngineAttribute for details on how to use this API operation.

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.

func (*OpsWorksCM) ListTagsForResource 

func (c *OpsWorksCM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) ListTagsForResourcePages 

func (c *OpsWorksCM) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *opsworkscm.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpsWorksCM) ListTagsForResourcePagesWithContext 

func (c *OpsWorksCM) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.

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.

func (*OpsWorksCM) ListTagsForResourceRequest 

func (c *OpsWorksCM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) ListTagsForResourceWithContext 

func (c *OpsWorksCM) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

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.

func (*OpsWorksCM) RestoreServer 

func (c *OpsWorksCM) RestoreServer(input *RestoreServerInput) (*RestoreServerOutput, error)

RestoreServer 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation RestoreServer for usage and error information.

Returned Error Types:

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) RestoreServerRequest 

func (c *OpsWorksCM) RestoreServerRequest(input *RestoreServerInput) (req *request.Request, output *RestoreServerOutput)

RestoreServerRequest generates a "aws/request.Request" representing the client's request for the RestoreServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreServer for more information on using the RestoreServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RestoreServerRequest method.
req, resp := client.RestoreServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) RestoreServerWithContext 

func (c *OpsWorksCM) RestoreServerWithContext(ctx aws.Context, input *RestoreServerInput, opts ...request.Option) (*RestoreServerOutput, error)

RestoreServerWithContext is the same as RestoreServer with the addition of the ability to pass a context and additional request options.

See RestoreServer for details on how to use this API operation.

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.

func (*OpsWorksCM) StartMaintenance 

func (c *OpsWorksCM) StartMaintenance(input *StartMaintenanceInput) (*StartMaintenanceOutput, error)

StartMaintenance 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation StartMaintenance for usage and error information.

Returned Error Types:

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) StartMaintenanceRequest 

func (c *OpsWorksCM) StartMaintenanceRequest(input *StartMaintenanceInput) (req *request.Request, output *StartMaintenanceOutput)

StartMaintenanceRequest generates a "aws/request.Request" representing the client's request for the StartMaintenance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartMaintenance for more information on using the StartMaintenance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartMaintenanceRequest method.
req, resp := client.StartMaintenanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) StartMaintenanceWithContext 

func (c *OpsWorksCM) StartMaintenanceWithContext(ctx aws.Context, input *StartMaintenanceInput, opts ...request.Option) (*StartMaintenanceOutput, error)

StartMaintenanceWithContext is the same as StartMaintenance with the addition of the ability to pass a context and additional request options.

See StartMaintenance for details on how to use this API operation.

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.

func (*OpsWorksCM) TagResource 

func (c *OpsWorksCM) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

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

func (*OpsWorksCM) TagResourceRequest 

func (c *OpsWorksCM) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) TagResourceWithContext 

func (c *OpsWorksCM) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

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.

func (*OpsWorksCM) UntagResource 

func (c *OpsWorksCM) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS OpsWorks CM.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

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

func (*OpsWorksCM) UntagResourceRequest 

func (c *OpsWorksCM) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) UntagResourceWithContext 

func (c *OpsWorksCM) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

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.

func (*OpsWorksCM) UpdateServer 

func (c *OpsWorksCM) UpdateServer(input *UpdateServerInput) (*UpdateServerOutput, error)

UpdateServer API operation for AWS OpsWorks CM.

Updates settings for a server.

This operation is synchronous.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation UpdateServer for usage and error information.

Returned Error Types:

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) UpdateServerEngineAttributes 

func (c *OpsWorksCM) UpdateServerEngineAttributes(input *UpdateServerEngineAttributesInput) (*UpdateServerEngineAttributesOutput, error)

UpdateServerEngineAttributes 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS OpsWorks CM's API operation UpdateServerEngineAttributes for usage and error information.

Returned Error Types:

  • InvalidStateException The resource is in a state that does not allow you to perform a specified action.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

  • ValidationException One or more of the provided request parameters are not valid.

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

func (*OpsWorksCM) UpdateServerEngineAttributesRequest 

func (c *OpsWorksCM) UpdateServerEngineAttributesRequest(input *UpdateServerEngineAttributesInput) (req *request.Request, output *UpdateServerEngineAttributesOutput)

UpdateServerEngineAttributesRequest generates a "aws/request.Request" representing the client's request for the UpdateServerEngineAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateServerEngineAttributes for more information on using the UpdateServerEngineAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateServerEngineAttributesRequest method.
req, resp := client.UpdateServerEngineAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) UpdateServerEngineAttributesWithContext 

func (c *OpsWorksCM) UpdateServerEngineAttributesWithContext(ctx aws.Context, input *UpdateServerEngineAttributesInput, opts ...request.Option) (*UpdateServerEngineAttributesOutput, error)

UpdateServerEngineAttributesWithContext is the same as UpdateServerEngineAttributes with the addition of the ability to pass a context and additional request options.

See UpdateServerEngineAttributes for details on how to use this API operation.

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.

func (*OpsWorksCM) UpdateServerRequest 

func (c *OpsWorksCM) UpdateServerRequest(input *UpdateServerInput) (req *request.Request, output *UpdateServerOutput)

UpdateServerRequest generates a "aws/request.Request" representing the client's request for the UpdateServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateServer for more information on using the UpdateServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateServerRequest method.
req, resp := client.UpdateServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*OpsWorksCM) UpdateServerWithContext 

func (c *OpsWorksCM) UpdateServerWithContext(ctx aws.Context, input *UpdateServerInput, opts ...request.Option) (*UpdateServerOutput, error)

UpdateServerWithContext is the same as UpdateServer with the addition of the ability to pass a context and additional request options.

See UpdateServer for details on how to use this API operation.

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.

func (*OpsWorksCM) WaitUntilNodeAssociated 

func (c *OpsWorksCM) WaitUntilNodeAssociated(input *DescribeNodeAssociationStatusInput) 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.

func (*OpsWorksCM) WaitUntilNodeAssociatedWithContext 

func (c *OpsWorksCM) WaitUntilNodeAssociatedWithContext(ctx aws.Context, input *DescribeNodeAssociationStatusInput, opts ...request.WaiterOption) error

WaitUntilNodeAssociatedWithContext is an extended version of WaitUntilNodeAssociated. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Error or informational message in response to a CreateServer request that
	// a resource cannot be created because it already exists.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The requested resource cannot be created because it already exists.

func (*ResourceAlreadyExistsException) Code 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Error or informational message that can contain more detail about problems
	// locating or accessing a resource.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The requested resource does not exist, or access was denied.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s RestoreServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreServerInput) SetBackupId 

func (s *RestoreServerInput) SetBackupId(v string) *RestoreServerInput

SetBackupId sets the BackupId field's value.

func (*RestoreServerInput) SetInstanceType 

func (s *RestoreServerInput) SetInstanceType(v string) *RestoreServerInput

SetInstanceType sets the InstanceType field's value.

func (*RestoreServerInput) SetKeyPair 

func (s *RestoreServerInput) SetKeyPair(v string) *RestoreServerInput

SetKeyPair sets the KeyPair field's value.

func (*RestoreServerInput) SetServerName 

func (s *RestoreServerInput) SetServerName(v string) *RestoreServerInput

SetServerName sets the ServerName field's value.

func (RestoreServerInput) String 

func (s RestoreServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// Describes a configuration management server.
	Server *Server `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreServerOutput) GoString 

func (s RestoreServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreServerOutput) SetServer 

func (s *RestoreServerOutput) SetServer(v *Server) *RestoreServerOutput

SetServer sets the Server field's value.

func (RestoreServerOutput) String 

func (s RestoreServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 2. For a Puppet server, specify either 2019 or
	// 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 *string `type:"string" enum:"MaintenanceStatus"`

	// 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 *string `type:"string" enum:"ServerStatus"`

	// 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) GoString 

func (s Server) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Server) SetAssociatePublicIpAddress 

func (s *Server) SetAssociatePublicIpAddress(v bool) *Server

SetAssociatePublicIpAddress sets the AssociatePublicIpAddress field's value.

func (*Server) SetBackupRetentionCount 

func (s *Server) SetBackupRetentionCount(v int64) *Server

SetBackupRetentionCount sets the BackupRetentionCount field's value.

func (*Server) SetCloudFormationStackArn 

func (s *Server) SetCloudFormationStackArn(v string) *Server

SetCloudFormationStackArn sets the CloudFormationStackArn field's value.

func (*Server) SetCreatedAt 

func (s *Server) SetCreatedAt(v time.Time) *Server

SetCreatedAt sets the CreatedAt field's value.

func (*Server) SetCustomDomain 

func (s *Server) SetCustomDomain(v string) *Server

SetCustomDomain sets the CustomDomain field's value.

func (*Server) SetDisableAutomatedBackup 

func (s *Server) SetDisableAutomatedBackup(v bool) *Server

SetDisableAutomatedBackup sets the DisableAutomatedBackup field's value.

func (*Server) SetEndpoint 

func (s *Server) SetEndpoint(v string) *Server

SetEndpoint sets the Endpoint field's value.

func (*Server) SetEngine 

func (s *Server) SetEngine(v string) *Server

SetEngine sets the Engine field's value.

func (*Server) SetEngineAttributes 

func (s *Server) SetEngineAttributes(v []*EngineAttribute) *Server

SetEngineAttributes sets the EngineAttributes field's value.

func (*Server) SetEngineModel 

func (s *Server) SetEngineModel(v string) *Server

SetEngineModel sets the EngineModel field's value.

func (*Server) SetEngineVersion 

func (s *Server) SetEngineVersion(v string) *Server

SetEngineVersion sets the EngineVersion field's value.

func (*Server) SetInstanceProfileArn 

func (s *Server) SetInstanceProfileArn(v string) *Server

SetInstanceProfileArn sets the InstanceProfileArn field's value.

func (*Server) SetInstanceType 

func (s *Server) SetInstanceType(v string) *Server

SetInstanceType sets the InstanceType field's value.

func (*Server) SetKeyPair 

func (s *Server) SetKeyPair(v string) *Server

SetKeyPair sets the KeyPair field's value.

func (*Server) SetMaintenanceStatus 

func (s *Server) SetMaintenanceStatus(v string) *Server

SetMaintenanceStatus sets the MaintenanceStatus field's value.

func (*Server) SetPreferredBackupWindow 

func (s *Server) SetPreferredBackupWindow(v string) *Server

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*Server) SetPreferredMaintenanceWindow 

func (s *Server) SetPreferredMaintenanceWindow(v string) *Server

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*Server) SetSecurityGroupIds 

func (s *Server) SetSecurityGroupIds(v []*string) *Server

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*Server) SetServerArn 

func (s *Server) SetServerArn(v string) *Server

SetServerArn sets the ServerArn field's value.

func (*Server) SetServerName 

func (s *Server) SetServerName(v string) *Server

SetServerName sets the ServerName field's value.

func (*Server) SetServiceRoleArn 

func (s *Server) SetServiceRoleArn(v string) *Server

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*Server) SetStatus 

func (s *Server) SetStatus(v string) *Server

SetStatus sets the Status field's value.

func (*Server) SetStatusReason 

func (s *Server) SetStatusReason(v string) *Server

SetStatusReason sets the StatusReason field's value.

func (*Server) SetSubnetIds 

func (s *Server) SetSubnetIds(v []*string) *Server

SetSubnetIds sets the SubnetIds field's value.

func (Server) String 

func (s Server) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s ServerEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerEvent) SetCreatedAt 

func (s *ServerEvent) SetCreatedAt(v time.Time) *ServerEvent

SetCreatedAt sets the CreatedAt field's value.

func (*ServerEvent) SetLogUrl 

func (s *ServerEvent) SetLogUrl(v string) *ServerEvent

SetLogUrl sets the LogUrl field's value.

func (*ServerEvent) SetMessage 

func (s *ServerEvent) SetMessage(v string) *ServerEvent

SetMessage sets the Message field's value.

func (*ServerEvent) SetServerName 

func (s *ServerEvent) SetServerName(v string) *ServerEvent

SetServerName sets the ServerName field's value.

func (ServerEvent) String 

func (s ServerEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s StartMaintenanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMaintenanceInput) SetEngineAttributes 

func (s *StartMaintenanceInput) SetEngineAttributes(v []*EngineAttribute) *StartMaintenanceInput

SetEngineAttributes sets the EngineAttributes field's value.

func (*StartMaintenanceInput) SetServerName 

func (s *StartMaintenanceInput) SetServerName(v string) *StartMaintenanceInput

SetServerName sets the ServerName field's value.

func (StartMaintenanceInput) String 

func (s StartMaintenanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s StartMaintenanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMaintenanceOutput) SetServer 

func (s *StartMaintenanceOutput) SetServer(v *Server) *StartMaintenanceOutput

SetServer sets the Server field's value.

func (StartMaintenanceOutput) String 

func (s StartMaintenanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag 

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) GoString 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate 

func (s *Tag) Validate() error

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

type TagResourceInput 

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) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput 

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) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s UpdateServerEngineAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServerEngineAttributesInput) SetAttributeName 

func (s *UpdateServerEngineAttributesInput) SetAttributeName(v string) *UpdateServerEngineAttributesInput

SetAttributeName sets the AttributeName field's value.

func (*UpdateServerEngineAttributesInput) SetAttributeValue 

func (s *UpdateServerEngineAttributesInput) SetAttributeValue(v string) *UpdateServerEngineAttributesInput

SetAttributeValue sets the AttributeValue field's value.

func (*UpdateServerEngineAttributesInput) SetServerName 

func (s *UpdateServerEngineAttributesInput) SetServerName(v string) *UpdateServerEngineAttributesInput

SetServerName sets the ServerName field's value.

func (UpdateServerEngineAttributesInput) String 

func (s UpdateServerEngineAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s UpdateServerEngineAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServerEngineAttributesOutput) SetServer 

func (s *UpdateServerEngineAttributesOutput) SetServer(v *Server) *UpdateServerEngineAttributesOutput

SetServer sets the Server field's value.

func (UpdateServerEngineAttributesOutput) String 

func (s UpdateServerEngineAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s UpdateServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServerInput) SetBackupRetentionCount 

func (s *UpdateServerInput) SetBackupRetentionCount(v int64) *UpdateServerInput

SetBackupRetentionCount sets the BackupRetentionCount field's value.

func (*UpdateServerInput) SetDisableAutomatedBackup 

func (s *UpdateServerInput) SetDisableAutomatedBackup(v bool) *UpdateServerInput

SetDisableAutomatedBackup sets the DisableAutomatedBackup field's value.

func (*UpdateServerInput) SetPreferredBackupWindow 

func (s *UpdateServerInput) SetPreferredBackupWindow(v string) *UpdateServerInput

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*UpdateServerInput) SetPreferredMaintenanceWindow 

func (s *UpdateServerInput) SetPreferredMaintenanceWindow(v string) *UpdateServerInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*UpdateServerInput) SetServerName 

func (s *UpdateServerInput) SetServerName(v string) *UpdateServerInput

SetServerName sets the ServerName field's value.

func (UpdateServerInput) String 

func (s UpdateServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s UpdateServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServerOutput) SetServer 

func (s *UpdateServerOutput) SetServer(v *Server) *UpdateServerOutput

SetServer sets the Server field's value.

func (UpdateServerOutput) String 

func (s UpdateServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Error or informational message that can contain more detail about a validation
	// failure.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

One or more of the provided request parameters are not valid.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.