types

package
v1.26.17 Latest Latest
Warning

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

 Go to latest Published: Feb 18, 2025 License: Apache-2.0 Imports: 3 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentVersion 

type AgentVersion struct {

	// The configuration manager.
	ConfigurationManager *StackConfigurationManager

	// The agent version.
	Version *string
	// contains filtered or unexported fields
}

Describes an agent version.

type App 

type App struct {

	// The app ID.
	AppId *string

	// A Source object that describes the app repository.
	AppSource *Source

	// The stack attributes.
	Attributes map[string]string

	// When the app was created.
	CreatedAt *string

	// The app's data sources.
	DataSources []DataSource

	// A description of the app.
	Description *string

	// The app vhost settings with multiple domains separated by commas. For example:
	// 'www.example.com, example.com'
	Domains []string

	// Whether to enable SSL for the app.
	EnableSsl *bool

	// An array of EnvironmentVariable objects that specify environment variables to
	// be associated with the app. After you deploy the app, these variables are
	// defined on the associated app server instances. For more information, see [Environment Variables].
	//
	// There is no specific limit on the number of environment variables. However, the
	// size of the associated data structure - which includes the variable names,
	// values, and protected flag values - cannot exceed 20 KB. This limit should
	// accommodate most if not all use cases, but if you do exceed it, you will cause
	// an exception (API) with an "Environment: is too large (maximum is 20 KB)"
	// message.
	//
	// [Environment Variables]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment
	Environment []EnvironmentVariable

	// The app name.
	Name *string

	// The app's short name.
	Shortname *string

	// An SslConfiguration object with the SSL configuration.
	SslConfiguration *SslConfiguration

	// The app stack ID.
	StackId *string

	// The app type.
	Type AppType
	// contains filtered or unexported fields
}

A description of the app.

type AppAttributesKeys 

type AppAttributesKeys string
const (
	AppAttributesKeysDocumentRoot        AppAttributesKeys = "DocumentRoot"
	AppAttributesKeysRailsEnv            AppAttributesKeys = "RailsEnv"
	AppAttributesKeysAutoBundleOnDeploy  AppAttributesKeys = "AutoBundleOnDeploy"
	AppAttributesKeysAwsFlowRubySettings AppAttributesKeys = "AwsFlowRubySettings"
)

Enum values for AppAttributesKeys

func (AppAttributesKeys) Values added in v0.29.0 

func (AppAttributesKeys) Values() []AppAttributesKeys

Values returns all known values for AppAttributesKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AppType 

type AppType string
const (
	AppTypeAwsFlowRuby AppType = "aws-flow-ruby"
	AppTypeJava        AppType = "java"
	AppTypeRails       AppType = "rails"
	AppTypePhp         AppType = "php"
	AppTypeNodejs      AppType = "nodejs"
	AppTypeStatic      AppType = "static"
	AppTypeOther       AppType = "other"
)

Enum values for AppType

func (AppType) Values added in v0.29.0 

func (AppType) Values() []AppType

Values returns all known values for AppType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Architecture 

type Architecture string
const (
	ArchitectureX8664 Architecture = "x86_64"
	ArchitectureI386  Architecture = "i386"
)

Enum values for Architecture

func (Architecture) Values added in v0.29.0 

func (Architecture) Values() []Architecture

Values returns all known values for Architecture. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AutoScalingThresholds 

type AutoScalingThresholds struct {

	// Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter
	// takes a list of up to five alarm names, which are case sensitive and must be in
	// the same region as the stack.
	//
	// To use custom alarms, you must update your service role to allow
	// cloudwatch:DescribeAlarms . You can either have OpsWorks Stacks update the role
	// for you when you first use this feature or you can edit the role manually. For
	// more information, see [Allowing OpsWorks Stacks to Act on Your Behalf].
	//
	// [Allowing OpsWorks Stacks to Act on Your Behalf]: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html
	Alarms []string

	// The CPU utilization threshold, as a percent of the available CPU. A value of -1
	// disables the threshold.
	CpuThreshold *float64

	// The amount of time (in minutes) after a scaling event occurs that OpsWorks
	// Stacks should ignore metrics and suppress additional scaling events. For
	// example, OpsWorks Stacks adds new instances following an upscaling event but the
	// instances won't start reducing the load until they have been booted and
	// configured. There is no point in raising additional scaling events during that
	// operation, which typically takes several minutes. IgnoreMetricsTime allows you
	// to direct OpsWorks Stacks to suppress scaling events long enough to get the new
	// instances online.
	IgnoreMetricsTime *int32

	// The number of instances to add or remove when the load exceeds a threshold.
	InstanceCount *int32

	// The load threshold. A value of -1 disables the threshold. For more information
	// about how load is computed, see [Load (computing)].
	//
	// [Load (computing)]: http://en.wikipedia.org/wiki/Load_%28computing%29
	LoadThreshold *float64

	// The memory utilization threshold, as a percent of the available memory. A value
	// of -1 disables the threshold.
	MemoryThreshold *float64

	// The amount of time, in minutes, that the load must exceed a threshold before
	// more instances are added or removed.
	ThresholdsWaitTime *int32
	// contains filtered or unexported fields
}

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when OpsWorks Stacks starts or stops load-based instances.

type AutoScalingType 

type AutoScalingType string
const (
	AutoScalingTypeLoad  AutoScalingType = "load"
	AutoScalingTypeTimer AutoScalingType = "timer"
)

Enum values for AutoScalingType

func (AutoScalingType) Values added in v0.29.0 

func (AutoScalingType) Values() []AutoScalingType

Values returns all known values for AutoScalingType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BlockDeviceMapping 

type BlockDeviceMapping struct {

	// The device name that is exposed to the instance, such as /dev/sdh . For the root
	// device, you can use the explicit device name or you can set this parameter to
	// ROOT_DEVICE and OpsWorks Stacks will provide the correct device name.
	DeviceName *string

	// An EBSBlockDevice that defines how to configure an Amazon EBS volume when the
	// instance is launched.
	Ebs *EbsBlockDevice

	// Suppresses the specified device included in the AMI's block device mapping.
	NoDevice *string

	// The virtual device name. For more information, see [BlockDeviceMapping].
	//
	// [BlockDeviceMapping]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html
	VirtualName *string
	// contains filtered or unexported fields
}

Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMappingdata type.

type ChefConfiguration 

type ChefConfiguration struct {

	// The Berkshelf version.
	BerkshelfVersion *string

	// Whether to enable Berkshelf.
	ManageBerkshelf *bool
	// contains filtered or unexported fields
}

Describes the Chef configuration.

type CloudWatchLogsConfiguration 

type CloudWatchLogsConfiguration struct {

	// Whether CloudWatch Logs is enabled for a layer.
	Enabled *bool

	// A list of configuration options for CloudWatch Logs.
	LogStreams []CloudWatchLogsLogStream
	// contains filtered or unexported fields
}

Describes the Amazon CloudWatch Logs configuration for a layer.

type CloudWatchLogsEncoding 

type CloudWatchLogsEncoding string
const (
	CloudWatchLogsEncodingAscii         CloudWatchLogsEncoding = "ascii"
	CloudWatchLogsEncodingBig5          CloudWatchLogsEncoding = "big5"
	CloudWatchLogsEncodingBig5hkscs     CloudWatchLogsEncoding = "big5hkscs"
	CloudWatchLogsEncodingCp037         CloudWatchLogsEncoding = "cp037"
	CloudWatchLogsEncodingCp424         CloudWatchLogsEncoding = "cp424"
	CloudWatchLogsEncodingCp437         CloudWatchLogsEncoding = "cp437"
	CloudWatchLogsEncodingCp500         CloudWatchLogsEncoding = "cp500"
	CloudWatchLogsEncodingCp720         CloudWatchLogsEncoding = "cp720"
	CloudWatchLogsEncodingCp737         CloudWatchLogsEncoding = "cp737"
	CloudWatchLogsEncodingCp775         CloudWatchLogsEncoding = "cp775"
	CloudWatchLogsEncodingCp850         CloudWatchLogsEncoding = "cp850"
	CloudWatchLogsEncodingCp852         CloudWatchLogsEncoding = "cp852"
	CloudWatchLogsEncodingCp855         CloudWatchLogsEncoding = "cp855"
	CloudWatchLogsEncodingCp856         CloudWatchLogsEncoding = "cp856"
	CloudWatchLogsEncodingCp857         CloudWatchLogsEncoding = "cp857"
	CloudWatchLogsEncodingCp858         CloudWatchLogsEncoding = "cp858"
	CloudWatchLogsEncodingCp860         CloudWatchLogsEncoding = "cp860"
	CloudWatchLogsEncodingCp861         CloudWatchLogsEncoding = "cp861"
	CloudWatchLogsEncodingCp862         CloudWatchLogsEncoding = "cp862"
	CloudWatchLogsEncodingCp863         CloudWatchLogsEncoding = "cp863"
	CloudWatchLogsEncodingCp864         CloudWatchLogsEncoding = "cp864"
	CloudWatchLogsEncodingCp865         CloudWatchLogsEncoding = "cp865"
	CloudWatchLogsEncodingCp866         CloudWatchLogsEncoding = "cp866"
	CloudWatchLogsEncodingCp869         CloudWatchLogsEncoding = "cp869"
	CloudWatchLogsEncodingCp874         CloudWatchLogsEncoding = "cp874"
	CloudWatchLogsEncodingCp875         CloudWatchLogsEncoding = "cp875"
	CloudWatchLogsEncodingCp932         CloudWatchLogsEncoding = "cp932"
	CloudWatchLogsEncodingCp949         CloudWatchLogsEncoding = "cp949"
	CloudWatchLogsEncodingCp950         CloudWatchLogsEncoding = "cp950"
	CloudWatchLogsEncodingCp1006        CloudWatchLogsEncoding = "cp1006"
	CloudWatchLogsEncodingCp1026        CloudWatchLogsEncoding = "cp1026"
	CloudWatchLogsEncodingCp1140        CloudWatchLogsEncoding = "cp1140"
	CloudWatchLogsEncodingCp1250        CloudWatchLogsEncoding = "cp1250"
	CloudWatchLogsEncodingCp1251        CloudWatchLogsEncoding = "cp1251"
	CloudWatchLogsEncodingCp1252        CloudWatchLogsEncoding = "cp1252"
	CloudWatchLogsEncodingCp1253        CloudWatchLogsEncoding = "cp1253"
	CloudWatchLogsEncodingCp1254        CloudWatchLogsEncoding = "cp1254"
	CloudWatchLogsEncodingCp1255        CloudWatchLogsEncoding = "cp1255"
	CloudWatchLogsEncodingCp1256        CloudWatchLogsEncoding = "cp1256"
	CloudWatchLogsEncodingCp1257        CloudWatchLogsEncoding = "cp1257"
	CloudWatchLogsEncodingCp1258        CloudWatchLogsEncoding = "cp1258"
	CloudWatchLogsEncodingEucJp         CloudWatchLogsEncoding = "euc_jp"
	CloudWatchLogsEncodingEucJis2004    CloudWatchLogsEncoding = "euc_jis_2004"
	CloudWatchLogsEncodingEucJisx0213   CloudWatchLogsEncoding = "euc_jisx0213"
	CloudWatchLogsEncodingEucKr         CloudWatchLogsEncoding = "euc_kr"
	CloudWatchLogsEncodingGb2312        CloudWatchLogsEncoding = "gb2312"
	CloudWatchLogsEncodingGbk           CloudWatchLogsEncoding = "gbk"
	CloudWatchLogsEncodingGb18030       CloudWatchLogsEncoding = "gb18030"
	CloudWatchLogsEncodingHz            CloudWatchLogsEncoding = "hz"
	CloudWatchLogsEncodingIso2022Jp     CloudWatchLogsEncoding = "iso2022_jp"
	CloudWatchLogsEncodingIso2022Jp1    CloudWatchLogsEncoding = "iso2022_jp_1"
	CloudWatchLogsEncodingIso2022Jp2    CloudWatchLogsEncoding = "iso2022_jp_2"
	CloudWatchLogsEncodingIso2022Jp2004 CloudWatchLogsEncoding = "iso2022_jp_2004"
	CloudWatchLogsEncodingIso2022Jp3    CloudWatchLogsEncoding = "iso2022_jp_3"
	CloudWatchLogsEncodingIso2022JpExt  CloudWatchLogsEncoding = "iso2022_jp_ext"
	CloudWatchLogsEncodingIso2022Kr     CloudWatchLogsEncoding = "iso2022_kr"
	CloudWatchLogsEncodingLatin1        CloudWatchLogsEncoding = "latin_1"
	CloudWatchLogsEncodingIso88592      CloudWatchLogsEncoding = "iso8859_2"
	CloudWatchLogsEncodingIso88593      CloudWatchLogsEncoding = "iso8859_3"
	CloudWatchLogsEncodingIso88594      CloudWatchLogsEncoding = "iso8859_4"
	CloudWatchLogsEncodingIso88595      CloudWatchLogsEncoding = "iso8859_5"
	CloudWatchLogsEncodingIso88596      CloudWatchLogsEncoding = "iso8859_6"
	CloudWatchLogsEncodingIso88597      CloudWatchLogsEncoding = "iso8859_7"
	CloudWatchLogsEncodingIso88598      CloudWatchLogsEncoding = "iso8859_8"
	CloudWatchLogsEncodingIso88599      CloudWatchLogsEncoding = "iso8859_9"
	CloudWatchLogsEncodingIso885910     CloudWatchLogsEncoding = "iso8859_10"
	CloudWatchLogsEncodingIso885913     CloudWatchLogsEncoding = "iso8859_13"
	CloudWatchLogsEncodingIso885914     CloudWatchLogsEncoding = "iso8859_14"
	CloudWatchLogsEncodingIso885915     CloudWatchLogsEncoding = "iso8859_15"
	CloudWatchLogsEncodingIso885916     CloudWatchLogsEncoding = "iso8859_16"
	CloudWatchLogsEncodingJohab         CloudWatchLogsEncoding = "johab"
	CloudWatchLogsEncodingKoi8R         CloudWatchLogsEncoding = "koi8_r"
	CloudWatchLogsEncodingKoi8U         CloudWatchLogsEncoding = "koi8_u"
	CloudWatchLogsEncodingMacCyrillic   CloudWatchLogsEncoding = "mac_cyrillic"
	CloudWatchLogsEncodingMacGreek      CloudWatchLogsEncoding = "mac_greek"
	CloudWatchLogsEncodingMacIceland    CloudWatchLogsEncoding = "mac_iceland"
	CloudWatchLogsEncodingMacLatin2     CloudWatchLogsEncoding = "mac_latin2"
	CloudWatchLogsEncodingMacRoman      CloudWatchLogsEncoding = "mac_roman"
	CloudWatchLogsEncodingMacTurkish    CloudWatchLogsEncoding = "mac_turkish"
	CloudWatchLogsEncodingPtcp154       CloudWatchLogsEncoding = "ptcp154"
	CloudWatchLogsEncodingShiftJis      CloudWatchLogsEncoding = "shift_jis"
	CloudWatchLogsEncodingShiftJis2004  CloudWatchLogsEncoding = "shift_jis_2004"
	CloudWatchLogsEncodingShiftJisx0213 CloudWatchLogsEncoding = "shift_jisx0213"
	CloudWatchLogsEncodingUtf32         CloudWatchLogsEncoding = "utf_32"
	CloudWatchLogsEncodingUtf32Be       CloudWatchLogsEncoding = "utf_32_be"
	CloudWatchLogsEncodingUtf32Le       CloudWatchLogsEncoding = "utf_32_le"
	CloudWatchLogsEncodingUtf16         CloudWatchLogsEncoding = "utf_16"
	CloudWatchLogsEncodingUtf16Be       CloudWatchLogsEncoding = "utf_16_be"
	CloudWatchLogsEncodingUtf16Le       CloudWatchLogsEncoding = "utf_16_le"
	CloudWatchLogsEncodingUtf7          CloudWatchLogsEncoding = "utf_7"
	CloudWatchLogsEncodingUtf8          CloudWatchLogsEncoding = "utf_8"
	CloudWatchLogsEncodingUtf8Sig       CloudWatchLogsEncoding = "utf_8_sig"
)

Enum values for CloudWatchLogsEncoding

func (CloudWatchLogsEncoding) Values added in v0.29.0 

func (CloudWatchLogsEncoding) Values() []CloudWatchLogsEncoding

Values returns all known values for CloudWatchLogsEncoding. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CloudWatchLogsInitialPosition 

type CloudWatchLogsInitialPosition string
const (
	CloudWatchLogsInitialPositionStartOfFile CloudWatchLogsInitialPosition = "start_of_file"
	CloudWatchLogsInitialPositionEndOfFile   CloudWatchLogsInitialPosition = "end_of_file"
)

Enum values for CloudWatchLogsInitialPosition

func (CloudWatchLogsInitialPosition) Values added in v0.29.0 

func (CloudWatchLogsInitialPosition) Values() []CloudWatchLogsInitialPosition

Values returns all known values for CloudWatchLogsInitialPosition. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CloudWatchLogsLogStream 

type CloudWatchLogsLogStream struct {

	// Specifies the max number of log events in a batch, up to 10000. The default
	// value is 1000.
	BatchCount *int32

	// Specifies the maximum size of log events in a batch, in bytes, up to 1048576
	// bytes. The default value is 32768 bytes. This size is calculated as the sum of
	// all event messages in UTF-8, plus 26 bytes for each log event.
	BatchSize *int32

	// Specifies the time duration for the batching of log events. The minimum value
	// is 5000ms and default value is 5000ms.
	BufferDuration *int32

	// Specifies how the time stamp is extracted from logs. For more information, see
	// the [CloudWatch Logs Agent Reference].
	//
	// [CloudWatch Logs Agent Reference]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html
	DatetimeFormat *string

	// Specifies the encoding of the log file so that the file can be read correctly.
	// The default is utf_8 . Encodings supported by Python codecs.decode() can be
	// used here.
	Encoding CloudWatchLogsEncoding

	// Specifies log files that you want to push to CloudWatch Logs.
	//
	// File can point to a specific file or multiple files (by using wild card
	// characters such as /var/log/system.log* ). Only the latest file is pushed to
	// CloudWatch Logs, based on file modification time. We recommend that you use wild
	// card characters to specify a series of files of the same type, such as
	// access_log.2014-06-01-01 , access_log.2014-06-01-02 , and so on by using a
	// pattern like access_log.* . Don't use a wildcard to match multiple file types,
	// such as access_log_80 and access_log_443 . To specify multiple, different file
	// types, add another log stream entry to the configuration file, so that each log
	// file type is stored in a different log group.
	//
	// Zipped files are not supported.
	File *string

	// Specifies the range of lines for identifying a file. The valid values are one
	// number, or two dash-delimited numbers, such as '1', '2-5'. The default value is
	// '1', meaning the first line is used to calculate the fingerprint. Fingerprint
	// lines are not sent to CloudWatch Logs unless all specified lines are available.
	FileFingerprintLines *string

	// Specifies where to start to read data (start_of_file or end_of_file). The
	// default is start_of_file. This setting is only used if there is no state
	// persisted for that log stream.
	InitialPosition CloudWatchLogsInitialPosition

	// Specifies the destination log group. A log group is created automatically if it
	// doesn't already exist. Log group names can be between 1 and 512 characters long.
	// Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/'
	// (forward slash), and '.' (period).
	LogGroupName *string

	// Specifies the pattern for identifying the start of a log message.
	MultiLineStartPattern *string

	// Specifies the time zone of log event time stamps.
	TimeZone CloudWatchLogsTimeZone
	// contains filtered or unexported fields
}

Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.

type CloudWatchLogsTimeZone 

type CloudWatchLogsTimeZone string
const (
	CloudWatchLogsTimeZoneLocal CloudWatchLogsTimeZone = "LOCAL"
	CloudWatchLogsTimeZoneUtc   CloudWatchLogsTimeZone = "UTC"
)

Enum values for CloudWatchLogsTimeZone

func (CloudWatchLogsTimeZone) Values added in v0.29.0 

func (CloudWatchLogsTimeZone) Values() []CloudWatchLogsTimeZone

Values returns all known values for CloudWatchLogsTimeZone. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Command 

type Command struct {

	// Date and time when the command was acknowledged.
	AcknowledgedAt *string

	// The command ID.
	CommandId *string

	// Date when the command completed.
	CompletedAt *string

	// Date and time when the command was run.
	CreatedAt *string

	// The command deployment ID.
	DeploymentId *string

	// The command exit code.
	ExitCode *int32

	// The ID of the instance where the command was executed.
	InstanceId *string

	// The URL of the command log.
	LogUrl *string

	// The command status:
	//
	//   - failed
	//
	//   - successful
	//
	//   - skipped
	//
	//   - pending
	Status *string

	// The command type:
	//
	//   - configure
	//
	//   - deploy
	//
	//   - execute_recipes
	//
	//   - install_dependencies
	//
	//   - restart
	//
	//   - rollback
	//
	//   - setup
	//
	//   - start
	//
	//   - stop
	//
	//   - undeploy
	//
	//   - update_custom_cookbooks
	//
	//   - update_dependencies
	Type *string
	// contains filtered or unexported fields
}

Describes a command.

type DataSource 

type DataSource struct {

	// The data source's ARN.
	Arn *string

	// The database name.
	DatabaseName *string

	// The data source's type, AutoSelectOpsworksMysqlInstance , OpsworksMysqlInstance
	// , RdsDbInstance , or None .
	Type *string
	// contains filtered or unexported fields
}

Describes an app's data source.

type Deployment 

type Deployment struct {

	// The app ID.
	AppId *string

	// Used to specify a stack or deployment command.
	Command *DeploymentCommand

	// A user-defined comment.
	Comment *string

	// Date when the deployment completed.
	CompletedAt *string

	// Date when the deployment was created.
	CreatedAt *string

	// A string that contains user-defined custom JSON. It can be used to override the
	// corresponding default stack configuration attribute values for stack or to pass
	// data to recipes. The string should be in the following format:
	//
	//     "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
	//
	// For more information on custom JSON, see [Use Custom JSON to Modify the Stack Configuration Attributes].
	//
	// [Use Custom JSON to Modify the Stack Configuration Attributes]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html
	CustomJson *string

	// The deployment ID.
	DeploymentId *string

	// The deployment duration.
	Duration *int32

	// The user's IAM ARN.
	IamUserArn *string

	// The IDs of the target instances.
	InstanceIds []string

	// The stack ID.
	StackId *string

	// The deployment status:
	//
	//   - running
	//
	//   - successful
	//
	//   - failed
	Status *string
	// contains filtered or unexported fields
}

Describes a deployment of a stack or app.

type DeploymentCommand 

type DeploymentCommand struct {

	// Specifies the operation. You can specify only one command.
	//
	// For stacks, the following commands are available:
	//
	//   - execute_recipes : Execute one or more recipes. To specify the recipes, set
	//   an Args parameter named recipes to the list of recipes to be executed. For
	//   example, to execute phpapp::appsetup , set Args to
	//   {"recipes":["phpapp::appsetup"]} .
	//
	//   - install_dependencies : Install the stack's dependencies.
	//
	//   - update_custom_cookbooks : Update the stack's custom cookbooks.
	//
	//   - update_dependencies : Update the stack's dependencies.
	//
	// The update_dependencies and install_dependencies commands are supported only
	// for Linux instances. You can run the commands successfully on Windows instances,
	// but they do nothing.
	//
	// For apps, the following commands are available:
	//
	//   - deploy : Deploy an app. Ruby on Rails apps have an optional Args parameter
	//   named migrate . Set Args to {"migrate":["true"]} to migrate the database. The
	//   default setting is {"migrate":["false"]}.
	//
	//   - rollback Roll the app back to the previous version. When you update an app,
	//   OpsWorks Stacks stores the previous version, up to a maximum of five versions.
	//   You can use this command to roll an app back as many as four versions.
	//
	//   - start : Start the app's web or application server.
	//
	//   - stop : Stop the app's web or application server.
	//
	//   - restart : Restart the app's web or application server.
	//
	//   - undeploy : Undeploy the app.
	//
	// This member is required.
	Name DeploymentCommandName

	// The arguments of those commands that take arguments. It should be set to a JSON
	// object with the following format:
	//
	//     {"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2",
	//     ...], ...}
	//
	// The update_dependencies command takes two arguments:
	//
	//   - upgrade_os_to - Specifies the Amazon Linux version that you want instances
	//   to run, such as Amazon Linux 2 . You must also set the allow_reboot argument
	//   to true.
	//
	//   - allow_reboot - Specifies whether to allow OpsWorks Stacks to reboot the
	//   instances if necessary, after installing the updates. This argument can be set
	//   to either true or false . The default value is false .
	//
	// For example, to upgrade an instance to Amazon Linux 2018.03, set Args to the
	// following.
	//
	//     { "upgrade_os_to":["Amazon Linux 2018.03"], "allow_reboot":["true"] }
	Args map[string][]string
	// contains filtered or unexported fields
}

Used to specify a stack or deployment command.

type DeploymentCommandName 

type DeploymentCommandName string
const (
	DeploymentCommandNameInstallDependencies   DeploymentCommandName = "install_dependencies"
	DeploymentCommandNameUpdateDependencies    DeploymentCommandName = "update_dependencies"
	DeploymentCommandNameUpdateCustomCookbooks DeploymentCommandName = "update_custom_cookbooks"
	DeploymentCommandNameExecuteRecipes        DeploymentCommandName = "execute_recipes"
	DeploymentCommandNameConfigure             DeploymentCommandName = "configure"
	DeploymentCommandNameSetup                 DeploymentCommandName = "setup"
	DeploymentCommandNameDeploy                DeploymentCommandName = "deploy"
	DeploymentCommandNameRollback              DeploymentCommandName = "rollback"
	DeploymentCommandNameStart                 DeploymentCommandName = "start"
	DeploymentCommandNameStop                  DeploymentCommandName = "stop"
	DeploymentCommandNameRestart               DeploymentCommandName = "restart"
	DeploymentCommandNameUndeploy              DeploymentCommandName = "undeploy"
)

Enum values for DeploymentCommandName

func (DeploymentCommandName) Values added in v0.29.0 

func (DeploymentCommandName) Values() []DeploymentCommandName

Values returns all known values for DeploymentCommandName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EbsBlockDevice 

type EbsBlockDevice struct {

	// Whether the volume is deleted on instance termination.
	DeleteOnTermination *bool

	// The number of I/O operations per second (IOPS) that the volume supports. For
	// more information, see [EbsBlockDevice].
	//
	// [EbsBlockDevice]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html
	Iops *int32

	// The snapshot ID.
	SnapshotId *string

	// The volume size, in GiB. For more information, see [EbsBlockDevice].
	//
	// [EbsBlockDevice]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html
	VolumeSize *int32

	// The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned
	// IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1
	// for Cold HDD,and standard for Magnetic volumes.
	//
	// If you specify the io1 volume type, you must also specify a value for the Iops
	// attribute. The maximum ratio of provisioned IOPS to requested volume size (in
	// GiB) is 50:1. Amazon Web Services uses the default volume size (in GiB)
	// specified in the AMI attributes to set IOPS to 50 x (volume size).
	VolumeType VolumeType
	// contains filtered or unexported fields
}

Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.

type EcsCluster 

type EcsCluster struct {

	// The cluster's ARN.
	EcsClusterArn *string

	// The cluster name.
	EcsClusterName *string

	// The time and date that the cluster was registered with the stack.
	RegisteredAt *string

	// The stack ID.
	StackId *string
	// contains filtered or unexported fields
}

Describes a registered Amazon ECS cluster.

type ElasticIp 

type ElasticIp struct {

	// The domain.
	Domain *string

	// The ID of the instance that the address is attached to.
	InstanceId *string

	// The IP address.
	Ip *string

	// The name, which can be a maximum of 32 characters.
	Name *string

	// The Amazon Web Services Region. For more information, see [Regions and Endpoints].
	//
	// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html
	Region *string
	// contains filtered or unexported fields
}

Describes an Elastic IP address.

type ElasticLoadBalancer 

type ElasticLoadBalancer struct {

	// A list of Availability Zones.
	AvailabilityZones []string

	// The instance's public DNS name.
	DnsName *string

	// A list of the EC2 instances for which the Elastic Load Balancing instance is
	// managing traffic.
	Ec2InstanceIds []string

	// The Elastic Load Balancing instance name.
	ElasticLoadBalancerName *string

	// The ID of the layer to which the instance is attached.
	LayerId *string

	// The instance's Amazon Web Services Region.
	Region *string

	// The ID of the stack with which the instance is associated.
	StackId *string

	// A list of subnet IDs, if the stack is running in a VPC.
	SubnetIds []string

	// The VPC ID.
	VpcId *string
	// contains filtered or unexported fields
}

Describes an Elastic Load Balancing instance.

type EnvironmentVariable 

type EnvironmentVariable struct {

	// (Required) The environment variable's name, which can consist of up to 64
	// characters and must be specified. The name can contain upper- and lowercase
	// letters, numbers, and underscores (_), but it must start with a letter or
	// underscore.
	//
	// This member is required.
	Key *string

	// (Optional) The environment variable's value, which can be left empty. If you
	// specify a value, it can contain up to 256 characters, which must all be
	// printable.
	//
	// This member is required.
	Value *string

	// (Optional) Whether the variable's value is returned by the DescribeApps action. To hide an
	// environment variable's value, set Secure to true . DescribeApps returns
	// *****FILTERED***** instead of the actual value. The default value for Secure is
	// false .
	Secure *bool
	// contains filtered or unexported fields
}

Represents an app's environment variable.

type Instance 

type Instance struct {

	// The agent version. This parameter is set to INHERIT if the instance inherits
	// the default stack setting or to a a version number for a fixed agent version.
	AgentVersion *string

	// A custom AMI ID to be used to create the instance. For more information, see [Instances]
	//
	// [Instances]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html
	AmiId *string

	// The instance architecture: "i386" or "x86_64".
	Architecture Architecture

	// The instance's Amazon Resource Number (ARN).
	Arn *string

	// For load-based or time-based instances, the type.
	AutoScalingType AutoScalingType

	// The instance Availability Zone. For more information, see [Regions and Endpoints].
	//
	// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html
	AvailabilityZone *string

	// An array of BlockDeviceMapping objects that specify the instance's block device
	// mappings.
	BlockDeviceMappings []BlockDeviceMapping

	// The time that the instance was created.
	CreatedAt *string

	// Whether this is an Amazon EBS-optimized instance.
	EbsOptimized *bool

	// The ID of the associated Amazon EC2 instance.
	Ec2InstanceId *string

	// For container instances, the Amazon ECS cluster's ARN.
	EcsClusterArn *string

	// For container instances, the instance's ARN.
	EcsContainerInstanceArn *string

	// The instance [Elastic IP address].
	//
	// [Elastic IP address]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html
	ElasticIp *string

	// The instance host name. The following are character limits for instance host
	// names.
	//
	//   - Linux-based instances: 63 characters
	//
	//   - Windows-based instances: 15 characters
	Hostname *string

	// For registered instances, the infrastructure class: ec2 or on-premises .
	InfrastructureClass *string

	// Whether to install operating system and package updates when the instance
	// boots. The default value is true . If this value is set to false , you must
	// update instances manually by using CreateDeploymentto run the update_dependencies stack command
	// or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
	//
	// We strongly recommend using the default value of true to ensure that your
	// instances have the latest security updates.
	InstallUpdatesOnBoot *bool

	// The instance ID.
	InstanceId *string

	// The ARN of the instance's IAM profile. For more information about IAM ARNs, see [Using Identifiers]
	// .
	//
	// [Using Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
	InstanceProfileArn *string

	// The instance type, such as t2.micro .
	InstanceType *string

	// The ID of the last service error. For more information, call DescribeServiceErrors.
	LastServiceErrorId *string

	// An array containing the instance layer IDs.
	LayerIds []string

	// The instance's operating system.
	Os *string

	// The instance's platform.
	Platform *string

	// The instance's private DNS name.
	PrivateDns *string

	// The instance's private IP address.
	PrivateIp *string

	// The instance public DNS name.
	PublicDns *string

	// The instance public IP address.
	PublicIp *string

	// For registered instances, who performed the registration.
	RegisteredBy *string

	// The instance's reported OpsWorks Stacks agent version.
	ReportedAgentVersion *string

	// For registered instances, the reported operating system.
	ReportedOs *ReportedOs

	// The instance's root device type. For more information, see [Storage for the Root Device].
	//
	// [Storage for the Root Device]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device
	RootDeviceType RootDeviceType

	// The root device volume ID.
	RootDeviceVolumeId *string

	// An array containing the instance security group IDs.
	SecurityGroupIds []string

	// The SSH key's Deep Security Agent (DSA) fingerprint.
	SshHostDsaKeyFingerprint *string

	// The SSH key's RSA fingerprint.
	SshHostRsaKeyFingerprint *string

	// The instance's Amazon EC2 key-pair name.
	SshKeyName *string

	// The stack ID.
	StackId *string

	// The instance status:
	//
	//   - booting
	//
	//   - connection_lost
	//
	//   - online
	//
	//   - pending
	//
	//   - rebooting
	//
	//   - requested
	//
	//   - running_setup
	//
	//   - setup_failed
	//
	//   - shutting_down
	//
	//   - start_failed
	//
	//   - stop_failed
	//
	//   - stopped
	//
	//   - stopping
	//
	//   - terminated
	//
	//   - terminating
	Status *string

	// The instance's subnet ID; applicable only if the stack is running in a VPC.
	SubnetId *string

	// The instance's tenancy option, such as dedicated or host .
	Tenancy *string

	// The instance's virtualization type: paravirtual or hvm .
	VirtualizationType VirtualizationType
	// contains filtered or unexported fields
}

Describes an instance.

type InstanceIdentity 

type InstanceIdentity struct {

	// A JSON document that contains the metadata.
	Document *string

	// A signature that can be used to verify the document's accuracy and authenticity.
	Signature *string
	// contains filtered or unexported fields
}

Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.

type InstancesCount 

type InstancesCount struct {

	// The number of instances in the Assigning state.
	Assigning *int32

	// The number of instances with booting status.
	Booting *int32

	// The number of instances with connection_lost status.
	ConnectionLost *int32

	// The number of instances in the Deregistering state.
	Deregistering *int32

	// The number of instances with online status.
	Online *int32

	// The number of instances with pending status.
	Pending *int32

	// The number of instances with rebooting status.
	Rebooting *int32

	// The number of instances in the Registered state.
	Registered *int32

	// The number of instances in the Registering state.
	Registering *int32

	// The number of instances with requested status.
	Requested *int32

	// The number of instances with running_setup status.
	RunningSetup *int32

	// The number of instances with setup_failed status.
	SetupFailed *int32

	// The number of instances with shutting_down status.
	ShuttingDown *int32

	// The number of instances with start_failed status.
	StartFailed *int32

	// The number of instances with stop_failed status.
	StopFailed *int32

	// The number of instances with stopped status.
	Stopped *int32

	// The number of instances with stopping status.
	Stopping *int32

	// The number of instances with terminated status.
	Terminated *int32

	// The number of instances with terminating status.
	Terminating *int32

	// The number of instances in the Unassigning state.
	Unassigning *int32
	// contains filtered or unexported fields
}

Describes how many instances a stack has for each status.

type Layer 

type Layer struct {

	// The Amazon Resource Number (ARN) of a layer.
	Arn *string

	// The layer attributes.
	//
	// For the HaproxyStatsPassword , MysqlRootPassword , and GangliaPassword
	// attributes, OpsWorks Stacks returns *****FILTERED***** instead of the actual
	// value
	//
	// For an ECS Cluster layer, OpsWorks Stacks the EcsClusterArn attribute is set to
	// the cluster's ARN.
	Attributes map[string]string

	// Whether to automatically assign an [Elastic IP address] to the layer's instances. For more
	// information, see [How to Edit a Layer].
	//
	// [How to Edit a Layer]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html
	// [Elastic IP address]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html
	AutoAssignElasticIps *bool

	// For stacks that are running in a VPC, whether to automatically assign a public
	// IP address to the layer's instances. For more information, see [How to Edit a Layer].
	//
	// [How to Edit a Layer]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html
	AutoAssignPublicIps *bool

	// The Amazon CloudWatch Logs configuration settings for the layer.
	CloudWatchLogsConfiguration *CloudWatchLogsConfiguration

	// Date when the layer was created.
	CreatedAt *string

	// The ARN of the default IAM profile to be used for the layer's EC2 instances.
	// For more information about IAM ARNs, see [Using Identifiers].
	//
	// [Using Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
	CustomInstanceProfileArn *string

	// A JSON formatted string containing the layer's custom stack configuration and
	// deployment attributes.
	CustomJson *string

	// A LayerCustomRecipes object that specifies the layer's custom recipes.
	CustomRecipes *Recipes

	// An array containing the layer's custom security group IDs.
	CustomSecurityGroupIds []string

	// OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy,
	// undeploy, and shutdown. For each layer, OpsWorks Stacks runs a set of standard
	// recipes for each event. You can also provide custom recipes for any or all
	// layers and events. OpsWorks Stacks runs custom event recipes after the standard
	// recipes. LayerCustomRecipes specifies the custom recipes for a particular layer
	// to be run in response to each of the five events.
	//
	// To specify a recipe, use the cookbook's directory name in the repository
	// followed by two colons and the recipe name, which is the recipe's file name
	// without the .rb extension. For example: phpapp2::dbsetup specifies the
	// dbsetup.rb recipe in the repository's phpapp2 folder.
	DefaultRecipes *Recipes

	// An array containing the layer's security group names.
	DefaultSecurityGroupNames []string

	// Whether auto healing is disabled for the layer.
	EnableAutoHealing *bool

	// Whether to install operating system and package updates when the instance
	// boots. The default value is true . If this value is set to false , you must then
	// update your instances manually by using CreateDeploymentto run the update_dependencies stack
	// command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the
	// instances.
	//
	// We strongly recommend using the default value of true , to ensure that your
	// instances have the latest security updates.
	InstallUpdatesOnBoot *bool

	// The layer ID.
	LayerId *string

	// A LifeCycleEventConfiguration object that specifies the Shutdown event
	// configuration.
	LifecycleEventConfiguration *LifecycleEventConfiguration

	// The layer name. Layer names can be a maximum of 32 characters.
	Name *string

	// An array of Package objects that describe the layer's packages.
	Packages []string

	// The layer short name.
	Shortname *string

	// The layer stack ID.
	StackId *string

	// The layer type.
	Type LayerType

	// Whether the layer uses Amazon EBS-optimized instances.
	UseEbsOptimizedInstances *bool

	// A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
	VolumeConfigurations []VolumeConfiguration
	// contains filtered or unexported fields
}

Describes a layer.

type LayerAttributesKeys 

type LayerAttributesKeys string
const (
	LayerAttributesKeysEcsClusterArn               LayerAttributesKeys = "EcsClusterArn"
	LayerAttributesKeysEnableHaproxyStats          LayerAttributesKeys = "EnableHaproxyStats"
	LayerAttributesKeysHaproxyStatsUrl             LayerAttributesKeys = "HaproxyStatsUrl"
	LayerAttributesKeysHaproxyStatsUser            LayerAttributesKeys = "HaproxyStatsUser"
	LayerAttributesKeysHaproxyStatsPassword        LayerAttributesKeys = "HaproxyStatsPassword"
	LayerAttributesKeysHaproxyHealthCheckUrl       LayerAttributesKeys = "HaproxyHealthCheckUrl"
	LayerAttributesKeysHaproxyHealthCheckMethod    LayerAttributesKeys = "HaproxyHealthCheckMethod"
	LayerAttributesKeysMysqlRootPassword           LayerAttributesKeys = "MysqlRootPassword"
	LayerAttributesKeysMysqlRootPasswordUbiquitous LayerAttributesKeys = "MysqlRootPasswordUbiquitous"
	LayerAttributesKeysGangliaUrl                  LayerAttributesKeys = "GangliaUrl"
	LayerAttributesKeysGangliaUser                 LayerAttributesKeys = "GangliaUser"
	LayerAttributesKeysGangliaPassword             LayerAttributesKeys = "GangliaPassword"
	LayerAttributesKeysMemcachedMemory             LayerAttributesKeys = "MemcachedMemory"
	LayerAttributesKeysNodejsVersion               LayerAttributesKeys = "NodejsVersion"
	LayerAttributesKeysRubyVersion                 LayerAttributesKeys = "RubyVersion"
	LayerAttributesKeysRubygemsVersion             LayerAttributesKeys = "RubygemsVersion"
	LayerAttributesKeysManageBundler               LayerAttributesKeys = "ManageBundler"
	LayerAttributesKeysBundlerVersion              LayerAttributesKeys = "BundlerVersion"
	LayerAttributesKeysRailsStack                  LayerAttributesKeys = "RailsStack"
	LayerAttributesKeysPassengerVersion            LayerAttributesKeys = "PassengerVersion"
	LayerAttributesKeysJvm                         LayerAttributesKeys = "Jvm"
	LayerAttributesKeysJvmVersion                  LayerAttributesKeys = "JvmVersion"
	LayerAttributesKeysJvmOptions                  LayerAttributesKeys = "JvmOptions"
	LayerAttributesKeysJavaAppServer               LayerAttributesKeys = "JavaAppServer"
	LayerAttributesKeysJavaAppServerVersion        LayerAttributesKeys = "JavaAppServerVersion"
)

Enum values for LayerAttributesKeys

func (LayerAttributesKeys) Values added in v0.29.0 

func (LayerAttributesKeys) Values() []LayerAttributesKeys

Values returns all known values for LayerAttributesKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LayerType 

type LayerType string
const (
	LayerTypeAwsFlowRuby      LayerType = "aws-flow-ruby"
	LayerTypeEcsCluster       LayerType = "ecs-cluster"
	LayerTypeJavaApp          LayerType = "java-app"
	LayerTypeLb               LayerType = "lb"
	LayerTypeWeb              LayerType = "web"
	LayerTypePhpApp           LayerType = "php-app"
	LayerTypeRailsApp         LayerType = "rails-app"
	LayerTypeNodejsApp        LayerType = "nodejs-app"
	LayerTypeMemcached        LayerType = "memcached"
	LayerTypeDbMaster         LayerType = "db-master"
	LayerTypeMonitoringMaster LayerType = "monitoring-master"
	LayerTypeCustom           LayerType = "custom"
)

Enum values for LayerType

func (LayerType) Values added in v0.29.0 

func (LayerType) Values() []LayerType

Values returns all known values for LayerType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LifecycleEventConfiguration 

type LifecycleEventConfiguration struct {

	// A ShutdownEventConfiguration object that specifies the Shutdown event
	// configuration.
	Shutdown *ShutdownEventConfiguration
	// contains filtered or unexported fields
}

Specifies the lifecycle event configuration

type LoadBasedAutoScalingConfiguration 

type LoadBasedAutoScalingConfiguration struct {

	// An AutoScalingThresholds object that describes the downscaling configuration,
	// which defines how and when OpsWorks Stacks reduces the number of instances.
	DownScaling *AutoScalingThresholds

	// Whether load-based auto scaling is enabled for the layer.
	Enable *bool

	// The layer ID.
	LayerId *string

	// An AutoScalingThresholds object that describes the upscaling configuration,
	// which defines how and when OpsWorks Stacks increases the number of instances.
	UpScaling *AutoScalingThresholds
	// contains filtered or unexported fields
}

Describes a layer's load-based auto scaling configuration.

type OperatingSystem 

type OperatingSystem struct {

	// Supported configuration manager name and versions for an OpsWorks Stacks
	// operating system.
	ConfigurationManagers []OperatingSystemConfigurationManager

	// The ID of a supported operating system, such as Amazon Linux 2 .
	Id *string

	// The name of the operating system, such as Amazon Linux 2 .
	Name *string

	// A short name for the operating system manufacturer.
	ReportedName *string

	// The version of the operating system, including the release and edition, if
	// applicable.
	ReportedVersion *string

	// Indicates that an operating system is not supported for new instances.
	Supported *bool

	// The type of a supported operating system, either Linux or Windows .
	Type *string
	// contains filtered or unexported fields
}

Describes supported operating systems in OpsWorks Stacks.

type OperatingSystemConfigurationManager 

type OperatingSystemConfigurationManager struct {

	// The name of the configuration manager, which is Chef.
	Name *string

	// The versions of the configuration manager that are supported by an operating
	// system.
	Version *string
	// contains filtered or unexported fields
}

A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.

type Permission 

type Permission struct {

	// Whether the user can use SSH.
	AllowSsh *bool

	// Whether the user can use sudo.
	AllowSudo *bool

	// The Amazon Resource Name (ARN) for an Identity and Access Management (IAM)
	// role. For more information about IAM ARNs, see [Using Identifiers].
	//
	// [Using Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
	IamUserArn *string

	// The user's permission level, which must be the following:
	//
	//   - deny
	//
	//   - show
	//
	//   - deploy
	//
	//   - manage
	//
	//   - iam_only
	//
	// For more information on the permissions associated with these levels, see [Managing User Permissions]
	//
	// [Managing User Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
	Level *string

	// A stack ID.
	StackId *string
	// contains filtered or unexported fields
}

Describes stack or user permissions.

type RaidArray 

type RaidArray struct {

	// The array's Availability Zone. For more information, see [Regions and Endpoints].
	//
	// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html
	AvailabilityZone *string

	// When the RAID array was created.
	CreatedAt *string

	// The array's Linux device. For example /dev/mdadm0.
	Device *string

	// The instance ID.
	InstanceId *string

	// For PIOPS volumes, the IOPS per disk.
	Iops *int32

	// The array's mount point.
	MountPoint *string

	// The array name.
	Name *string

	// The number of disks in the array.
	NumberOfDisks *int32

	// The array ID.
	RaidArrayId *string

	// The [RAID level].
	//
	// [RAID level]: http://en.wikipedia.org/wiki/Standard_RAID_levels
	RaidLevel *int32

	// The array's size.
	Size *int32

	// The stack ID.
	StackId *string

	// The volume type, standard or PIOPS.
	VolumeType *string
	// contains filtered or unexported fields
}

Describes an instance's RAID array.

type RdsDbInstance 

type RdsDbInstance struct {

	// The instance's address.
	Address *string

	// The database instance identifier.
	DbInstanceIdentifier *string

	// OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
	DbPassword *string

	// The master user name.
	DbUser *string

	// The instance's database engine.
	Engine *string

	// Set to true if OpsWorks Stacks is unable to discover the Amazon RDS instance.
	// OpsWorks Stacks attempts to discover the instance only once. If this value is
	// set to true , you must deregister the instance, and then register it again.
	MissingOnRds *bool

	// The instance's ARN.
	RdsDbInstanceArn *string

	// The instance's Amazon Web Services Region.
	Region *string

	// The ID of the stack with which the instance is registered.
	StackId *string
	// contains filtered or unexported fields
}

Describes an Amazon RDS instance.

type Recipes 

type Recipes struct {

	// An array of custom recipe names to be run following a configure event.
	Configure []string

	// An array of custom recipe names to be run following a deploy event.
	Deploy []string

	// An array of custom recipe names to be run following a setup event.
	Setup []string

	// An array of custom recipe names to be run following a shutdown event.
	Shutdown []string

	// An array of custom recipe names to be run following a undeploy event.
	Undeploy []string
	// contains filtered or unexported fields
}

OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

type ReportedOs 

type ReportedOs struct {

	// The operating system family.
	Family *string

	// The operating system name.
	Name *string

	// The operating system version.
	Version *string
	// contains filtered or unexported fields
}

A registered instance's reported operating system.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that a resource was not found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type RootDeviceType 

type RootDeviceType string
const (
	RootDeviceTypeEbs           RootDeviceType = "ebs"
	RootDeviceTypeInstanceStore RootDeviceType = "instance-store"
)

Enum values for RootDeviceType

func (RootDeviceType) Values added in v0.29.0 

func (RootDeviceType) Values() []RootDeviceType

Values returns all known values for RootDeviceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SelfUserProfile 

type SelfUserProfile struct {

	// The user's IAM ARN.
	IamUserArn *string

	// The user's name.
	Name *string

	// The user's SSH public key.
	SshPublicKey *string

	// The user's SSH user name.
	SshUsername *string
	// contains filtered or unexported fields
}

Describes a user's SSH information.

type ServiceError 

type ServiceError struct {

	// When the error occurred.
	CreatedAt *string

	// The instance ID.
	InstanceId *string

	// A message that describes the error.
	Message *string

	// The error ID.
	ServiceErrorId *string

	// The stack ID.
	StackId *string

	// The error type.
	Type *string
	// contains filtered or unexported fields
}

Describes an OpsWorks Stacks service error.

type ShutdownEventConfiguration 

type ShutdownEventConfiguration struct {

	// Whether to enable Elastic Load Balancing connection draining. For more
	// information, see [Connection Draining]
	//
	// [Connection Draining]: https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain
	DelayUntilElbConnectionsDrained *bool

	// The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown
	// event before shutting down an instance.
	ExecutionTimeout *int32
	// contains filtered or unexported fields
}

The Shutdown event configuration.

type Source 

type Source struct {

	// When included in a request, the parameter depends on the repository type.
	//
	//   - For Amazon S3 bundles, set Password to the appropriate IAM secret access key.
	//
	//   - For HTTP bundles and Subversion repositories, set Password to the password.
	//
	// For more information on how to safely handle IAM credentials, see [https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html].
	//
	// In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual
	// value.
	//
	// [https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html]: https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html
	Password *string

	// The application's version. OpsWorks Stacks enables you to easily deploy new
	// versions of an application. One of the simplest approaches is to have branches
	// or revisions in your repository that represent different versions that can
	// potentially be deployed.
	Revision *string

	// In requests, the repository's SSH key.
	//
	// In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual
	// value.
	SshKey *string

	// The repository type.
	Type SourceType

	// The source URL. The following is an example of an Amazon S3 source URL:
	// https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz .
	Url *string

	// This parameter depends on the repository type.
	//
	//   - For Amazon S3 bundles, set Username to the appropriate IAM access key ID.
	//
	//   - For HTTP bundles, Git repositories, and Subversion repositories, set
	//   Username to the user name.
	Username *string
	// contains filtered or unexported fields
}

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Appsor Custom Recipes and Cookbooks.

type SourceType 

type SourceType string
const (
	SourceTypeGit     SourceType = "git"
	SourceTypeSvn     SourceType = "svn"
	SourceTypeArchive SourceType = "archive"
	SourceTypeS3      SourceType = "s3"
)

Enum values for SourceType

func (SourceType) Values added in v0.29.0 

func (SourceType) Values() []SourceType

Values returns all known values for SourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SslConfiguration 

type SslConfiguration struct {

	// The contents of the certificate's domain.crt file.
	//
	// This member is required.
	Certificate *string

	// The private key; the contents of the certificate's domain.kex file.
	//
	// This member is required.
	PrivateKey *string

	// Optional. Can be used to specify an intermediate certificate authority key or
	// client authentication.
	Chain *string
	// contains filtered or unexported fields
}

Describes an app's SSL configuration.

type Stack 

type Stack struct {

	// The agent version. This parameter is set to LATEST for auto-update. or a
	// version number for a fixed agent version.
	AgentVersion *string

	// The stack's ARN.
	Arn *string

	// The stack's attributes.
	Attributes map[string]string

	// A ChefConfiguration object that specifies whether to enable Berkshelf and the
	// Berkshelf version. For more information, see [Create a New Stack].
	//
	// [Create a New Stack]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html
	ChefConfiguration *ChefConfiguration

	// The configuration manager.
	ConfigurationManager *StackConfigurationManager

	// The date when the stack was created.
	CreatedAt *string

	// Contains the information required to retrieve an app or cookbook from a
	// repository. For more information, see [Adding Apps]or [Cookbooks and Recipes].
	//
	// [Cookbooks and Recipes]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html
	// [Adding Apps]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html
	CustomCookbooksSource *Source

	// A JSON object that contains user-defined attributes to be added to the stack
	// configuration and deployment attributes. You can use custom JSON to override the
	// corresponding default stack configuration attribute values or to pass data to
	// recipes. The string should be in the following format:
	//
	//     "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
	//
	// For more information on custom JSON, see [Use Custom JSON to Modify the Stack Configuration Attributes].
	//
	// [Use Custom JSON to Modify the Stack Configuration Attributes]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html
	CustomJson *string

	// The stack's default Availability Zone. For more information, see [Regions and Endpoints].
	//
	// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html
	DefaultAvailabilityZone *string

	// The ARN of an IAM profile that is the default profile for all of the stack's
	// EC2 instances. For more information about IAM ARNs, see [Using Identifiers].
	//
	// [Using Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
	DefaultInstanceProfileArn *string

	// The stack's default operating system.
	DefaultOs *string

	// The default root device type. This value is used by default for all instances
	// in the stack, but you can override it when you create an instance. For more
	// information, see [Storage for the Root Device].
	//
	// [Storage for the Root Device]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device
	DefaultRootDeviceType RootDeviceType

	// A default Amazon EC2 key pair for the stack's instances. You can override this
	// value when you create or update an instance.
	DefaultSshKeyName *string

	// The default subnet ID; applicable only if the stack is running in a VPC.
	DefaultSubnetId *string

	// The stack host name theme, with spaces replaced by underscores.
	HostnameTheme *string

	// The stack name. Stack names can be a maximum of 64 characters.
	Name *string

	// The stack Amazon Web Services Region, such as ap-northeast-2 . For more
	// information about Amazon Web Services Regions, see [Regions and Endpoints].
	//
	// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html
	Region *string

	// The stack Identity and Access Management (IAM) role.
	ServiceRoleArn *string

	// The stack ID.
	StackId *string

	// Whether the stack uses custom cookbooks.
	UseCustomCookbooks *bool

	// Whether the stack automatically associates the OpsWorks Stacks built-in
	// security groups with the stack's layers.
	UseOpsworksSecurityGroups *bool

	// The VPC ID; applicable only if the stack is running in a VPC.
	VpcId *string
	// contains filtered or unexported fields
}

Describes a stack.

type StackAttributesKeys 

type StackAttributesKeys string
const (
	StackAttributesKeysColor StackAttributesKeys = "Color"
)

Enum values for StackAttributesKeys

func (StackAttributesKeys) Values added in v0.29.0 

func (StackAttributesKeys) Values() []StackAttributesKeys

Values returns all known values for StackAttributesKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackConfigurationManager 

type StackConfigurationManager struct {

	// The name. This parameter must be set to Chef .
	Name *string

	// The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux
	// stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is
	// 12.
	Version *string
	// contains filtered or unexported fields
}

Describes the configuration manager.

type StackSummary 

type StackSummary struct {

	// The number of apps.
	AppsCount *int32

	// The stack's ARN.
	Arn *string

	// An InstancesCount object with the number of instances in each status.
	InstancesCount *InstancesCount

	// The number of layers.
	LayersCount *int32

	// The stack name.
	Name *string

	// The stack ID.
	StackId *string
	// contains filtered or unexported fields
}

Summarizes the number of layers, instances, and apps in a stack.

type TemporaryCredential 

type TemporaryCredential struct {

	// The instance's OpsWorks Stacks ID.
	InstanceId *string

	// The password.
	Password *string

	// The user name.
	Username *string

	// The length of time (in minutes) that the grant is valid. When the grant
	// expires, at the end of this period, the user will no longer be able to use the
	// credentials to log in. If they are logged in at the time, they are automatically
	// logged out.
	ValidForInMinutes *int32
	// contains filtered or unexported fields
}

Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.

type TimeBasedAutoScalingConfiguration 

type TimeBasedAutoScalingConfiguration struct {

	// A WeeklyAutoScalingSchedule object with the instance schedule.
	AutoScalingSchedule *WeeklyAutoScalingSchedule

	// The instance ID.
	InstanceId *string
	// contains filtered or unexported fields
}

Describes an instance's time-based auto scaling configuration.

type UserProfile 

type UserProfile struct {

	// Whether users can specify their own SSH public key through the My Settings
	// page. For more information, see [Managing User Permissions].
	//
	// [Managing User Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html
	AllowSelfManagement *bool

	// The user's IAM ARN.
	IamUserArn *string

	// The user's name.
	Name *string

	// The user's SSH public key.
	SshPublicKey *string

	// The user's SSH user name.
	SshUsername *string
	// contains filtered or unexported fields
}

Describes a user's SSH information.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that a request was not valid.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type VirtualizationType 

type VirtualizationType string
const (
	VirtualizationTypeParavirtual VirtualizationType = "paravirtual"
	VirtualizationTypeHvm         VirtualizationType = "hvm"
)

Enum values for VirtualizationType

func (VirtualizationType) Values added in v0.29.0 

func (VirtualizationType) Values() []VirtualizationType

Values returns all known values for VirtualizationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Volume 

type Volume struct {

	// The volume Availability Zone. For more information, see [Regions and Endpoints].
	//
	// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html
	AvailabilityZone *string

	// The device name.
	Device *string

	// The Amazon EC2 volume ID.
	Ec2VolumeId *string

	// Specifies whether an Amazon EBS volume is encrypted. For more information, see [Amazon EBS Encryption].
	//
	// [Amazon EBS Encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html
	Encrypted *bool

	// The instance ID.
	InstanceId *string

	// For PIOPS volumes, the IOPS per disk.
	Iops *int32

	// The volume mount point. For example, "/mnt/disk1".
	MountPoint *string

	// The volume name. Volume names are a maximum of 128 characters.
	Name *string

	// The RAID array ID.
	RaidArrayId *string

	// The Amazon Web Services Region. For more information about Amazon Web Services
	// Regions, see [Regions and Endpoints].
	//
	// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html
	Region *string

	// The volume size.
	Size *int32

	// The value returned by [DescribeVolumes].
	//
	// [DescribeVolumes]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVolumes.html
	Status *string

	// The volume ID.
	VolumeId *string

	// The volume type. For more information, see [Amazon EBS Volume Types].
	//
	//   - standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and
	//   a maximum size of 1024 GiB.
	//
	//   - io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4
	//   GiB and a maximum size of 16384 GiB.
	//
	//   - gp2 - General Purpose (SSD). General purpose volumes must have a minimum
	//   size of 1 GiB and a maximum size of 16384 GiB.
	//
	//   - st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD
	//   volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.
	//
	//   - sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a
	//   maximum size of 16384 GiB.
	//
	// [Amazon EBS Volume Types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
	VolumeType *string
	// contains filtered or unexported fields
}

Describes an instance's Amazon EBS volume.

type VolumeConfiguration 

type VolumeConfiguration struct {

	// The volume mount point. For example "/dev/sdh".
	//
	// This member is required.
	MountPoint *string

	// The number of disks in the volume.
	//
	// This member is required.
	NumberOfDisks *int32

	// The volume size.
	//
	// This member is required.
	Size *int32

	// Specifies whether an Amazon EBS volume is encrypted. For more information, see [Amazon EBS Encryption].
	//
	// [Amazon EBS Encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html
	Encrypted *bool

	// For PIOPS volumes, the IOPS per disk.
	Iops *int32

	// The volume [RAID level].
	//
	// [RAID level]: http://en.wikipedia.org/wiki/Standard_RAID_levels
	RaidLevel *int32

	// The volume type. For more information, see [Amazon EBS Volume Types].
	//
	//   - standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and
	//   a maximum size of 1024 GiB.
	//
	//   - io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4
	//   GiB and a maximum size of 16384 GiB.
	//
	//   - gp2 - General Purpose (SSD). General purpose volumes must have a minimum
	//   size of 1 GiB and a maximum size of 16384 GiB.
	//
	//   - st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD
	//   volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.
	//
	//   - sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a
	//   maximum size of 16384 GiB.
	//
	// [Amazon EBS Volume Types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
	VolumeType *string
	// contains filtered or unexported fields
}

Describes an Amazon EBS volume configuration.

type VolumeType 

type VolumeType string
const (
	VolumeTypeGp2      VolumeType = "gp2"
	VolumeTypeIo1      VolumeType = "io1"
	VolumeTypeStandard VolumeType = "standard"
)

Enum values for VolumeType

func (VolumeType) Values added in v0.29.0 

func (VolumeType) Values() []VolumeType

Values returns all known values for VolumeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WeeklyAutoScalingSchedule 

type WeeklyAutoScalingSchedule struct {

	// The schedule for Friday.
	Friday map[string]string

	// The schedule for Monday.
	Monday map[string]string

	// The schedule for Saturday.
	Saturday map[string]string

	// The schedule for Sunday.
	Sunday map[string]string

	// The schedule for Thursday.
	Thursday map[string]string

	// The schedule for Tuesday.
	Tuesday map[string]string

	// The schedule for Wednesday.
	Wednesday map[string]string
	// contains filtered or unexported fields
}

Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.

  • The key is the time period (a UTC hour) and must be an integer from 0 - 23.

  • The value indicates whether the instance should be online or offline for the specified period, and must be set to "on" or "off"

The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.

The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day. 

{ "12":"on", "13":"on", "14":"on", "15":"on" }

Source Files

View all Source files

Jump to

Keyboard shortcuts

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