ActiveGo 1.8Package opsworkscm
Overview ▹
Index ▹
Constants
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"
)
const (
// BackupTypeAutomated is a BackupType enum value
BackupTypeAutomated = "AUTOMATED"
// BackupTypeManual is a BackupType enum value
BackupTypeManual = "MANUAL"
)
const (
// MaintenanceStatusSuccess is a MaintenanceStatus enum value
MaintenanceStatusSuccess = "SUCCESS"
// MaintenanceStatusFailed is a MaintenanceStatus enum value
MaintenanceStatusFailed = "FAILED"
)
The status of the association or disassociation request.
Possible values:
* SUCCESS: The association or disassociation succeeded. * FAILED: The association or disassociation failed. * IN_PROGRESS: The association or disassociation is still in progress.
const (
// NodeAssociationStatusSuccess is a NodeAssociationStatus enum value
NodeAssociationStatusSuccess = "SUCCESS"
// NodeAssociationStatusFailed is a NodeAssociationStatus enum value
NodeAssociationStatusFailed = "FAILED"
// NodeAssociationStatusInProgress is a NodeAssociationStatus enum value
NodeAssociationStatusInProgress = "IN_PROGRESS"
)
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"
)
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"
)
Service information constants
const (
ServiceName = "opsworks-cm" // Service endpoint prefix API calls made to.
EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)
type AccountAttribute ¶
Stores account attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/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
}
func (AccountAttribute) GoString ¶
func (s AccountAttribute) GoString() string
GoString returns the string representation
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
type AssociateNodeInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/AssociateNodeRequest
type AssociateNodeInput struct {
// Engine attributes used for associating the node.
//
// Attributes accepted in a AssociateNode request:
//
// * 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.
//
// EngineAttributes is a required field
EngineAttributes []*EngineAttribute `type:"list" required:"true"`
// The name of the Chef client 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
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
func (*AssociateNodeInput) Validate ¶
func (s *AssociateNodeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssociateNodeOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/AssociateNodeResponse
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
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
type Backup ¶
Describes a single backup. Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/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" timestampFormat:"unix"`
// A user-provided description for a manual backup. This field is empty for
// automated backups.
Description *string `type:"string"`
// The engine type that is obtained from the server when the backup is created.
Engine *string `type:"string"`
// The engine model that is obtained from the server when the backup is created.
EngineModel *string `type:"string"`
// The engine version that is obtained from the server when the backup is created.
EngineVersion *string `type:"string"`
// The EC2 instance profile ARN that is obtained from the server when the backup
// is created. Because this value is stored, you are not required to provide
// the InstanceProfileArn again if you restore a backup.
InstanceProfileArn *string `type:"string"`
// The instance type that is obtained from the server when the backup is created.
InstanceType *string `type:"string"`
// The key pair that is obtained from the server when the backup is created.
KeyPair *string `type:"string"`
// The preferred backup period that is obtained from the server when the backup
// is created.
PreferredBackupWindow *string `type:"string"`
// The preferred maintenance period that is obtained from the server when the
// backup is created.
PreferredMaintenanceWindow *string `type:"string"`
// This field is deprecated and is no longer used.
S3DataSize *int64 `deprecated:"true" type:"integer"`
// This field is deprecated and is no longer used.
S3DataUrl *string `deprecated:"true" type:"string"`
// The Amazon S3 URL of the backup's log file.
S3LogUrl *string `type:"string"`
// The security group IDs that are obtained from the server when the backup
// is created.
SecurityGroupIds []*string `type:"list"`
// The name of the server from which the backup was made.
ServerName *string `min:"1" type:"string"`
// The service role ARN that is obtained from the server when the backup is
// created.
ServiceRoleArn *string `type:"string"`
// The status of a backup while in progress.
Status *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 for Chef Automate-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
}
func (Backup) GoString ¶
func (s Backup) GoString() string
GoString returns the string representation
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
type CreateBackupInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateBackupRequest
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"`
// contains filtered or unexported fields
}
func (CreateBackupInput) GoString ¶
func (s CreateBackupInput) GoString() string
GoString returns the string representation
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) String ¶
func (s CreateBackupInput) String() string
String returns the string representation
func (*CreateBackupInput) Validate ¶
func (s *CreateBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateBackupOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateBackupResponse
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
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
type CreateServerInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateServerRequest
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 for Chef Automate 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 for Chef Automate deletes the oldest backups if
// this number is exceeded. The default value is 1.
BackupRetentionCount *int64 `min:"1" type:"integer"`
// 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 Chef.
Engine *string `type:"string"`
// Optional engine attributes on a specified server.
//
// Attributes accepted in a createServer request:
//
// * CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored
// by AWS OpsWorks for Chef. This private key is required to access the Chef
// API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in
// the response.
//
// * CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user
// in the Chef Automate GUI. 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_DELIVERY_ADMIN_PASSWORD is set, one is generated and returned
// in the response.
EngineAttributes []*EngineAttribute `type:"list"`
// The engine model, or option. Valid values include Single.
EngineModel *string `type:"string"`
// The major release version of the engine that you want to use. Values depend
// on the engine that you choose.
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. Valid values must be specified in the
// following format: ^([cm][34]|t2).* For example, m4.large. Valid values are
// t2.medium, m4.large, or m4.2xlarge.
//
// 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 for Chef Automate
// backs up application-level data on your server if automated backups are enabled.
// Valid values must be specified in one of the following formats:
//
// * HH:MM for daily backups
//
// * DDD:HH:MM for weekly backups
//
// The specified time is in coordinated universal time (UTC). The default value
// is a random, daily start time.
//
// Example:08:00, which represents a daily start time of 08:00 UTC.
//
// Example:Mon:08:00, which represents a start time of every Monday at 08:00
// UTC. (8:00 a.m.)
PreferredBackupWindow *string `type:"string"`
// The start time for a one-hour period each week during which AWS OpsWorks
// for Chef Automate performs maintenance on the instance. Valid values must
// be specified in the following format: DDD:HH:MM. The specified time is in
// coordinated universal time (UTC). The default value is a random one-hour
// period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more
// information.
//
// Example:Mon:08:00, which represents a start time of every Monday at 08:00
// UTC. (8:00 a.m.)
PreferredMaintenanceWindow *string `type:"string"`
// A list of security group IDs to attach to the Amazon EC2 instance. If you
// add this parameter, the specified security groups must be within the VPC
// that is specified by SubnetIds.
//
// If you do not specify this parameter, AWS OpsWorks for Chef Automate 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 for Chef Automate 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-stuff/latest/service-role-creation.yaml.
// This template creates a CloudFormation stack that includes the service role
// 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 (http://docs.aws.amazon.com/https:/docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html).
SubnetIds []*string `type:"list"`
// contains filtered or unexported fields
}
func (CreateServerInput) GoString ¶
func (s CreateServerInput) GoString() string
GoString returns the string representation
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) 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) String ¶
func (s CreateServerInput) String() string
String returns the string representation
func (*CreateServerInput) Validate ¶
func (s *CreateServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateServerOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateServerResponse
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
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
type DeleteBackupInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteBackupRequest
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
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
func (*DeleteBackupInput) Validate ¶
func (s *DeleteBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBackupOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteBackupResponse
type DeleteBackupOutput struct {
// contains filtered or unexported fields
}
func (DeleteBackupOutput) GoString ¶
func (s DeleteBackupOutput) GoString() string
GoString returns the string representation
func (DeleteBackupOutput) String ¶
func (s DeleteBackupOutput) String() string
String returns the string representation
type DeleteServerInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteServerRequest
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
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
func (*DeleteServerInput) Validate ¶
func (s *DeleteServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteServerOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteServerResponse
type DeleteServerOutput struct {
// contains filtered or unexported fields
}
func (DeleteServerOutput) GoString ¶
func (s DeleteServerOutput) GoString() string
GoString returns the string representation
func (DeleteServerOutput) String ¶
func (s DeleteServerOutput) String() string
String returns the string representation
type DescribeAccountAttributesInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeAccountAttributesRequest
type DescribeAccountAttributesInput struct {
// contains filtered or unexported fields
}
func (DescribeAccountAttributesInput) GoString ¶
func (s DescribeAccountAttributesInput) GoString() string
GoString returns the string representation
func (DescribeAccountAttributesInput) String ¶
func (s DescribeAccountAttributesInput) String() string
String returns the string representation
type DescribeAccountAttributesOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeAccountAttributesResponse
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
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
type DescribeBackupsInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeBackupsRequest
type DescribeBackupsInput struct {
// Describes a single backup.
BackupId *string `type:"string"`
// 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 DescribeBackups
// 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"`
// 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
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
func (*DescribeBackupsInput) Validate ¶
func (s *DescribeBackupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeBackupsOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeBackupsResponse
type DescribeBackupsOutput struct {
// Contains the response to a DescribeBackups request.
Backups []*Backup `type:"list"`
// 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 DescribeBackups
// 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 filtered or unexported fields
}
func (DescribeBackupsOutput) GoString ¶
func (s DescribeBackupsOutput) GoString() string
GoString returns the string representation
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
type DescribeEventsInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeEventsRequest
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
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
func (*DescribeEventsInput) Validate ¶
func (s *DescribeEventsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeEventsOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeEventsResponse
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
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
type DescribeNodeAssociationStatusInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeNodeAssociationStatusRequest
type DescribeNodeAssociationStatusInput struct {
// 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
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
func (*DescribeNodeAssociationStatusInput) Validate ¶
func (s *DescribeNodeAssociationStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeNodeAssociationStatusOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeNodeAssociationStatusResponse
type DescribeNodeAssociationStatusOutput struct {
// 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
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
type DescribeServersInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeServersRequest
type DescribeServersInput 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 DescribeServers
// 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"`
// 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
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
func (*DescribeServersInput) Validate ¶
func (s *DescribeServersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeServersOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeServersResponse
type DescribeServersOutput 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 DescribeServers
// 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 DescribeServers request.
Servers []*Server `type:"list"`
// contains filtered or unexported fields
}
func (DescribeServersOutput) GoString ¶
func (s DescribeServersOutput) GoString() string
GoString returns the string representation
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
type DisassociateNodeInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DisassociateNodeRequest
type DisassociateNodeInput struct {
// Engine attributes used for disassociating the node.
//
// Attributes accepted in a DisassociateNode request:
//
// * 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 Chef 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
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
func (*DisassociateNodeInput) Validate ¶
func (s *DisassociateNodeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisassociateNodeOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DisassociateNodeResponse
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
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
type EngineAttribute ¶
A name and value pair that is specific to the engine of the server. Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/EngineAttribute
type EngineAttribute struct {
// The name of the engine attribute.
Name *string `type:"string"`
// The value of the engine attribute.
Value *string `type:"string"`
// contains filtered or unexported fields
}
func (EngineAttribute) GoString ¶
func (s EngineAttribute) GoString() string
GoString returns the string representation
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
type OpsWorksCM ¶
OpsWorksCM provides the API operation methods for making requests to AWS OpsWorks for Chef Automate. 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.
type OpsWorksCM struct {
*client.Client
}
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:
// 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 for Chef Automate.
Associates a new node with the Chef server. This command is an alternative to knife bootstrap. For more information about how to disassociate a node, see DisassociateNode.
A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.
Example: aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=MyOrganization,Value=default" "Name=Chef_node_public_key,Value=Public_key_contents"
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 for Chef Automate's API operation AssociateNode for usage and error information.
Returned Error Codes:
* ErrCodeInvalidStateException "InvalidStateException" The resource is in a state that does not allow you to perform a specified action. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See AssociateNode for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AssociateNode method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
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 for Chef Automate's API operation CreateBackup for usage and error information.
Returned Error Codes:
* ErrCodeInvalidStateException "InvalidStateException" The resource is in a state that does not allow you to perform a specified action. * ErrCodeLimitExceededException "LimitExceededException" The limit of servers or backups has been reached. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See CreateBackup for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateBackup method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
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. 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.
By default, the Chef 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.
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 for Chef Automate's API operation CreateServer for usage and error information.
Returned Error Codes:
* ErrCodeLimitExceededException "LimitExceededException" The limit of servers or backups has been reached. * ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The requested resource cannot be created because it already exists. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See CreateServer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateServer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
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 for Chef Automate's API operation DeleteBackup for usage and error information.
Returned Error Codes:
* ErrCodeInvalidStateException "InvalidStateException" The resource is in a state that does not allow you to perform a specified action. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See DeleteBackup for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteBackup method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
Deletes the server and the underlying AWS CloudFormation stack (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 for Chef Automate's API operation DeleteServer for usage and error information.
Returned Error Codes:
* ErrCodeInvalidStateException "InvalidStateException" The resource is in a state that does not allow you to perform a specified action. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See DeleteServer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteServer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
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 for Chef Automate's API operation DescribeAccountAttributes for usage and error information. Please also see 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 can be used to capture response data after the request's "Send" method is called.
See DescribeAccountAttributes for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeAccountAttributes method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
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 for Chef Automate's API operation DescribeBackups for usage and error information.
Returned Error Codes:
* ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeInvalidNextTokenException "InvalidNextTokenException" This occurs when the provided nextToken is not valid.
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeBackups
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 can be used to capture response data after the request's "Send" method is called.
See DescribeBackups for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeBackups method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
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 for Chef Automate's API operation DescribeEvents for usage and error information.
Returned Error Codes:
* ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid. * ErrCodeInvalidNextTokenException "InvalidNextTokenException" This occurs when the provided nextToken is not valid. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied.
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeEvents
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 can be used to capture response data after the request's "Send" method is called.
See DescribeEvents for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeEvents method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
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 for Chef Automate's API operation DescribeNodeAssociationStatus for usage and error information.
Returned Error Codes:
* ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See DescribeNodeAssociationStatus for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeNodeAssociationStatus method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate 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 for Chef Automate's API operation DescribeServers for usage and error information.
Returned Error Codes:
* ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeInvalidNextTokenException "InvalidNextTokenException" This occurs when the provided nextToken is not valid.
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeServers
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 can be used to capture response data after the request's "Send" method is called.
See DescribeServers for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeServers method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
Disassociates a node from a Chef server, and removes the node from the Chef server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the Chef 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 for Chef Automate's API operation DisassociateNode for usage and error information.
Returned Error Codes:
* ErrCodeInvalidStateException "InvalidStateException" The resource is in a state that does not allow you to perform a specified action. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See DisassociateNode for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DisassociateNode method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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) RestoreServer ¶
func (c *OpsWorksCM) RestoreServer(input *RestoreServerInput) (*RestoreServerOutput, error)
RestoreServer API operation for AWS OpsWorks for Chef Automate.
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.
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 for Chef Automate's API operation RestoreServer for usage and error information.
Returned Error Codes:
* ErrCodeInvalidStateException "InvalidStateException" The resource is in a state that does not allow you to perform a specified action. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See RestoreServer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RestoreServer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 for Chef Automate.
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 for Chef Automate's API operation StartMaintenance for usage and error information.
Returned Error Codes:
* ErrCodeInvalidStateException "InvalidStateException" The resource is in a state that does not allow you to perform a specified action. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See StartMaintenance for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StartMaintenance method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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) UpdateServer ¶
func (c *OpsWorksCM) UpdateServer(input *UpdateServerInput) (*UpdateServerOutput, error)
UpdateServer API operation for AWS OpsWorks for Chef Automate.
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 for Chef Automate's API operation UpdateServer for usage and error information.
Returned Error Codes:
* ErrCodeInvalidStateException "InvalidStateException" The resource is in a state that does not allow you to perform a specified action. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 for Chef Automate.
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 the Chef server's private key (CHEF_PIVOTAL_KEY).
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 for Chef Automate's API operation UpdateServerEngineAttributes for usage and error information.
Returned Error Codes:
* ErrCodeInvalidStateException "InvalidStateException" The resource is in a state that does not allow you to perform a specified action. * ErrCodeResourceNotFoundException "ResourceNotFoundException" The requested resource does not exist, or access was denied. * ErrCodeValidationException "ValidationException" One or more of the provided request parameters are not valid.
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See UpdateServerEngineAttributes for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateServerEngineAttributes method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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 can be used to capture response data after the request's "Send" method is called.
See UpdateServer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateServer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
Please also see 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.
type RestoreServerInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/RestoreServerRequest
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 the instance to create. Valid values must be specified in the
// following format: ^([cm][34]|t2).* For example, m4.large. Valid values are
// t2.medium, m4.large, and m4.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
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
func (*RestoreServerInput) Validate ¶
func (s *RestoreServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RestoreServerOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/RestoreServerResponse
type RestoreServerOutput struct {
// contains filtered or unexported fields
}
func (RestoreServerOutput) GoString ¶
func (s RestoreServerOutput) GoString() string
GoString returns the string representation
func (RestoreServerOutput) String ¶
func (s RestoreServerOutput) String() string
String returns the string representation
type Server ¶
Describes a configuration management server. Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/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" timestampFormat:"unix"`
// 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
Endpoint *string `type:"string"`
// The engine type of the server. The valid value in this release is Chef.
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 for Chef Automate; they are returned only as part of the result
// of createServer().
//
// Attributes returned in a createServer response:
//
// * CHEF_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.
EngineAttributes []*EngineAttribute `type:"list"`
// The engine model of the server. The valid value in this release is Single.
EngineModel *string `type:"string"`
// The engine version of the server. Because Chef is the engine available in
// this release, the valid value for EngineVersion is 12.
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
}
func (Server) GoString ¶
func (s Server) GoString() string
GoString returns the string representation
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) 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
type ServerEvent ¶
An event that is related to the server, such as the start of maintenance or backup. Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/ServerEvent
type ServerEvent struct {
// The time when the event occurred.
CreatedAt *time.Time `type:"timestamp" timestampFormat:"unix"`
// 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
}
func (ServerEvent) GoString ¶
func (s ServerEvent) GoString() string
GoString returns the string representation
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
type StartMaintenanceInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/StartMaintenanceRequest
type StartMaintenanceInput struct {
// 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
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
func (*StartMaintenanceInput) Validate ¶
func (s *StartMaintenanceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartMaintenanceOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/StartMaintenanceResponse
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
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
type UpdateServerEngineAttributesInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServerEngineAttributesRequest
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
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
func (*UpdateServerEngineAttributesInput) Validate ¶
func (s *UpdateServerEngineAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateServerEngineAttributesOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServerEngineAttributesResponse
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
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
type UpdateServerInput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServerRequest
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
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
func (*UpdateServerInput) Validate ¶
func (s *UpdateServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateServerOutput ¶
Please also see https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServerResponse
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
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
Subdirectories
| Name | Synopsis |
|---|---|
| .. | |
| opsworkscmiface | Package opsworkscmiface provides an interface to enable mocking the AWS OpsWorks for Chef Automate service client for testing your code. |