1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package opsworkscm
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/opsworkscm/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates and immedately starts a new server. The server is ready to use when it
//
// is in the HEALTHY state. By default, you can create a maximum of 10 servers.
//
// This operation is asynchronous.
//
// A LimitExceededException is thrown when you have created the maximum number of
// servers (10). A ResourceAlreadyExistsException is thrown when a server with the
// same name already exists in the account. A ResourceNotFoundException is thrown
// when you specify a backup ID that is not valid or is for a backup that does not
// exist. A ValidationException is thrown when parameters of the request are not
// valid.
//
// If you do not specify a security group by adding the SecurityGroupIds
// parameter, AWS OpsWorks creates a new security group.
//
// Chef Automate: The default security group opens the Chef server to the world on
// TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is
// also open to the world on TCP port 22.
//
// Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433,
// 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH
// access. SSH is also open to the world on TCP port 22.
//
// By default, your server is accessible from any IP address. We recommend that
// you update your security group rules to allow access from known IP addresses and
// address ranges only. To edit security group rules, open Security Groups in the
// navigation pane of the EC2 management console.
//
// To specify your own domain for a server, and provide your own self-signed or
// CA-signed certificate and private key, specify values for CustomDomain ,
// CustomCertificate , and CustomPrivateKey .
func (c *Client) CreateServer(ctx context.Context, params *CreateServerInput, optFns ...func(*Options)) (*CreateServerOutput, error) {
if params == nil {
params = &CreateServerInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateServer", params, optFns, c.addOperationCreateServerMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateServerOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateServerInput struct {
// The configuration management engine to use. Valid values include ChefAutomate
// and Puppet .
//
// This member is required.
Engine *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.
//
// This member is required.
InstanceProfileArn *string
// The Amazon EC2 instance type to use. For example, m5.large .
//
// This member is required.
InstanceType *string
// 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.
//
// This member is required.
ServerName *string
// The service role that the AWS OpsWorks CM service backend uses to work with
// your account. Although the AWS OpsWorks management console typically creates the
// service role for you, if you are using the AWS CLI or API commands, run the
// service-role-creation.yaml AWS CloudFormation template, located at
// https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.
// This template creates a CloudFormation stack that includes the service role and
// instance profile that you need.
//
// This member is required.
ServiceRoleArn *string
// 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
// If you specify this field, AWS OpsWorks CM creates the server by using the
// backup represented by BackupId.
BackupId *string
// The number of automated backups that you want to keep. Whenever a new backup
// is created, AWS OpsWorks CM deletes the oldest backups if this number is
// exceeded. The default value is 1 .
BackupRetentionCount *int32
// A PEM-formatted HTTPS certificate. The value can be be a single, self-signed
// certificate, or a certificate chain. If you specify a custom certificate, you
// must also specify values for CustomDomain and CustomPrivateKey . The following
// are requirements for the CustomCertificate value:
//
// - You can provide either a self-signed, custom certificate, or the full
// certificate chain.
//
// - The certificate must be a valid X509 certificate, or a certificate chain in
// PEM format.
//
// - The certificate must be valid at the time of upload. A certificate can't be
// used before its validity period begins (the certificate's NotBefore date), or
// after it expires (the certificate's NotAfter date).
//
// - The certificate’s common name or subject alternative names (SANs), if
// present, must match the value of CustomDomain .
//
// - The certificate must match the value of CustomPrivateKey .
CustomCertificate *string
// An optional public endpoint of a server, such as https://aws.my-company.com . To
// access the server, create a CNAME DNS record in your preferred DNS service that
// points the custom domain to the endpoint that is generated when the server is
// created (the value of the CreateServer Endpoint attribute). You cannot access
// the server by using the generated Endpoint value if the server is using a
// custom domain. If you specify a custom domain, you must also specify values for
// CustomCertificate and CustomPrivateKey .
CustomDomain *string
// A private key in PEM format for connecting to the server by using HTTPS. The
// private key must not be encrypted; it cannot be protected by a password or
// passphrase. If you specify a custom private key, you must also specify values
// for CustomDomain and CustomCertificate .
CustomPrivateKey *string
// Enable or disable scheduled backups. Valid values are true or false . The
// default value is true .
DisableAutomatedBackup *bool
// Optional engine attributes on a specified server.
//
// Attributes accepted in a Chef createServer request:
//
// - CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The
// corresponding private key is required to access the Chef API. When no
// CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the
// response.
//
// - CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in
// the Chef Automate web-based dashboard. The password length is a minimum of eight
// characters, and a maximum of 32. The password can contain letters, numbers, and
// special characters (!/@#$%^&+=_). The password must contain at least one lower
// case letter, one upper case letter, one number, and one special character. When
// no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the
// response.
//
// Attributes accepted in a Puppet createServer request:
//
// - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a
// password must use ASCII characters.
//
// - PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository
// (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an
// r10k remote opens TCP port 8170.
//
// - PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add
// PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
EngineAttributes []types.EngineAttribute
// The engine model of the server. Valid values in this release include Monolithic
// for Puppet and Single for Chef.
EngineModel *string
// The major release version of the engine that you want to use. For a Chef
// server, the valid value for EngineVersion is currently 2 . For a Puppet server,
// valid values are 2019 or 2017 .
EngineVersion *string
// 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
// The start time for a one-hour period during which AWS OpsWorks CM backs up
// application-level data on your server if automated backups are enabled. Valid
// values must be specified in one of the following formats:
//
// - HH:MM for daily backups
//
// - DDD:HH:MM for weekly backups
//
// MM must be specified as 00 . The specified time is in coordinated universal time
// (UTC). The default value is a random, daily start time.
//
// Example: 08:00 , which represents a daily start time of 08:00 UTC.
//
// Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC.
// (8:00 a.m.)
PreferredBackupWindow *string
// The start time for a one-hour period each week during which AWS OpsWorks CM
// performs maintenance on the instance. Valid values must be specified in the
// following format: DDD:HH:MM . MM must be specified as 00 . The specified time is
// in coordinated universal time (UTC). The default value is a random one-hour
// period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more
// information.
//
// Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC.
// (8:00 a.m.)
PreferredMaintenanceWindow *string
// A list of security group IDs to attach to the Amazon EC2 instance. If you add
// this parameter, the specified security groups must be within the VPC that is
// specified by SubnetIds .
//
// If you do not specify this parameter, AWS OpsWorks CM creates one new security
// group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
SecurityGroupIds []string
// 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].
//
// [Supported Platforms]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html
SubnetIds []string
// A map that contains tag keys and tag values to attach to an AWS OpsWorks for
// Chef Automate or AWS OpsWorks for Puppet Enterprise server.
//
// - The key cannot be empty.
//
// - The key can be a maximum of 127 characters, and can contain only Unicode
// letters, numbers, or separators, or the following special characters: + - = .
// _ : / @
//
// - The value can be a maximum 255 characters, and contain only Unicode
// letters, numbers, or separators, or the following special characters: + - = .
// _ : / @
//
// - Leading and trailing white spaces are trimmed from both the key and value.
//
// - A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
Tags []types.Tag
noSmithyDocumentSerde
}
type CreateServerOutput struct {
// The server that is created by the request.
Server *types.Server
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateServerMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateServer{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateServer{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateServer"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpCreateServerValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateServer(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateServer(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateServer",
}
}
|