@datafire/amazonaws_opsworks
v5.0.0
Published
DataFire integration for AWS OpsWorks
Downloads
13
Readme
@datafire/amazonaws_opsworks
Client library for AWS OpsWorks
Installation and Usage
npm install --save @datafire/amazonaws_opsworks
let amazonaws_opsworks = require('@datafire/amazonaws_opsworks').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_opsworks.AssignInstance({
"InstanceId": "",
"LayerIds": []
}).then(data => {
console.log(data);
});
Description
AWS OpsWorks Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes. AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page. SDKs and CLI The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see: AWS CLI AWS SDK for Java AWS SDK for .NET AWS SDK for PHP 2 AWS SDK for Ruby AWS SDK for Node.js AWS SDK for Python(Boto) Endpoints AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created. opsworks.us-east-1.amazonaws.com opsworks.us-east-2.amazonaws.com opsworks.us-west-1.amazonaws.com opsworks.us-west-2.amazonaws.com opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console) opsworks.eu-west-1.amazonaws.com opsworks.eu-west-2.amazonaws.com opsworks.eu-west-3.amazonaws.com opsworks.eu-central-1.amazonaws.com opsworks.ap-northeast-1.amazonaws.com opsworks.ap-northeast-2.amazonaws.com opsworks.ap-south-1.amazonaws.com opsworks.ap-southeast-1.amazonaws.com opsworks.ap-southeast-2.amazonaws.com opsworks.sa-east-1.amazonaws.com Chef Versions When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions. You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
Actions
AssignInstance
amazonaws_opsworks.AssignInstance({
"InstanceId": "",
"LayerIds": []
}, context)
Input
Output
Output schema unknown
AssignVolume
amazonaws_opsworks.AssignVolume({
"VolumeId": ""
}, context)
Input
Output
Output schema unknown
AssociateElasticIp
amazonaws_opsworks.AssociateElasticIp({
"ElasticIp": ""
}, context)
Input
Output
Output schema unknown
AttachElasticLoadBalancer
amazonaws_opsworks.AttachElasticLoadBalancer({
"ElasticLoadBalancerName": "",
"LayerId": ""
}, context)
Input
Output
Output schema unknown
CloneStack
amazonaws_opsworks.CloneStack({
"SourceStackId": "",
"ServiceRoleArn": ""
}, context)
Input
- input
object
- AgentVersion String
- Attributes StackAttributes
- ChefConfiguration ChefConfiguration
- CloneAppIds Strings
- ClonePermissions Boolean
- ConfigurationManager StackConfigurationManager
- CustomCookbooksSource Source
- CustomJson String
- DefaultAvailabilityZone String
- DefaultInstanceProfileArn String
- DefaultOs String
- DefaultRootDeviceType RootDeviceType
- DefaultSshKeyName String
- DefaultSubnetId String
- HostnameTheme String
- Name String
- Region String
- ServiceRoleArn required String
- SourceStackId required String
- UseCustomCookbooks Boolean
- UseOpsworksSecurityGroups Boolean
- VpcId String
Output
- output CloneStackResult
CreateApp
amazonaws_opsworks.CreateApp({
"StackId": "",
"Name": "",
"Type": ""
}, context)
Input
- input
object
- AppSource Source
- Attributes AppAttributes
- DataSources DataSources
- Description String
- Domains Strings
- EnableSsl Boolean
- Environment EnvironmentVariables
- Name required String
- Shortname String
- SslConfiguration SslConfiguration
- StackId required String
- Type required AppType
Output
- output CreateAppResult
CreateDeployment
amazonaws_opsworks.CreateDeployment({
"StackId": "",
"Command": {
"Name": ""
}
}, context)
Input
- input
object
Output
- output CreateDeploymentResult
CreateInstance
amazonaws_opsworks.CreateInstance({
"StackId": "",
"LayerIds": [],
"InstanceType": ""
}, context)
Input
- input
object
- AgentVersion String
- AmiId String
- Architecture Architecture
- AutoScalingType AutoScalingType
- AvailabilityZone String
- BlockDeviceMappings BlockDeviceMappings
- EbsOptimized Boolean
- Hostname String
- InstallUpdatesOnBoot Boolean
- InstanceType required String
- LayerIds required Strings
- Os String
- RootDeviceType RootDeviceType
- SshKeyName String
- StackId required String
- SubnetId String
- Tenancy String
- VirtualizationType String
Output
- output CreateInstanceResult
CreateLayer
amazonaws_opsworks.CreateLayer({
"StackId": "",
"Type": "",
"Name": "",
"Shortname": ""
}, context)
Input
- input
object
- Attributes LayerAttributes
- AutoAssignElasticIps Boolean
- AutoAssignPublicIps Boolean
- CloudWatchLogsConfiguration CloudWatchLogsConfiguration
- CustomInstanceProfileArn String
- CustomJson String
- CustomRecipes Recipes
- CustomSecurityGroupIds Strings
- EnableAutoHealing Boolean
- InstallUpdatesOnBoot Boolean
- LifecycleEventConfiguration LifecycleEventConfiguration
- Name required String
- Packages Strings
- Shortname required String
- StackId required String
- Type required LayerType
- UseEbsOptimizedInstances Boolean
- VolumeConfigurations VolumeConfigurations
Output
- output CreateLayerResult
CreateStack
amazonaws_opsworks.CreateStack({
"Name": "",
"Region": "",
"ServiceRoleArn": "",
"DefaultInstanceProfileArn": ""
}, context)
Input
- input
object
- AgentVersion String
- Attributes StackAttributes
- ChefConfiguration ChefConfiguration
- ConfigurationManager StackConfigurationManager
- CustomCookbooksSource Source
- CustomJson String
- DefaultAvailabilityZone String
- DefaultInstanceProfileArn required String
- DefaultOs String
- DefaultRootDeviceType RootDeviceType
- DefaultSshKeyName String
- DefaultSubnetId String
- HostnameTheme String
- Name required String
- Region required String
- ServiceRoleArn required String
- UseCustomCookbooks Boolean
- UseOpsworksSecurityGroups Boolean
- VpcId String
Output
- output CreateStackResult
CreateUserProfile
amazonaws_opsworks.CreateUserProfile({
"IamUserArn": ""
}, context)
Input
- input
object
Output
- output CreateUserProfileResult
DeleteApp
amazonaws_opsworks.DeleteApp({
"AppId": ""
}, context)
Input
- input
object
- AppId required String
Output
Output schema unknown
DeleteInstance
amazonaws_opsworks.DeleteInstance({
"InstanceId": ""
}, context)
Input
Output
Output schema unknown
DeleteLayer
amazonaws_opsworks.DeleteLayer({
"LayerId": ""
}, context)
Input
- input
object
- LayerId required String
Output
Output schema unknown
DeleteStack
amazonaws_opsworks.DeleteStack({
"StackId": ""
}, context)
Input
- input
object
- StackId required String
Output
Output schema unknown
DeleteUserProfile
amazonaws_opsworks.DeleteUserProfile({
"IamUserArn": ""
}, context)
Input
- input
object
- IamUserArn required String
Output
Output schema unknown
DeregisterEcsCluster
amazonaws_opsworks.DeregisterEcsCluster({
"EcsClusterArn": ""
}, context)
Input
- input
object
- EcsClusterArn required String
Output
Output schema unknown
DeregisterElasticIp
amazonaws_opsworks.DeregisterElasticIp({
"ElasticIp": ""
}, context)
Input
- input
object
- ElasticIp required String
Output
Output schema unknown
DeregisterInstance
amazonaws_opsworks.DeregisterInstance({
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required String
Output
Output schema unknown
DeregisterRdsDbInstance
amazonaws_opsworks.DeregisterRdsDbInstance({
"RdsDbInstanceArn": ""
}, context)
Input
- input
object
- RdsDbInstanceArn required String
Output
Output schema unknown
DeregisterVolume
amazonaws_opsworks.DeregisterVolume({
"VolumeId": ""
}, context)
Input
- input
object
- VolumeId required String
Output
Output schema unknown
DescribeAgentVersions
amazonaws_opsworks.DescribeAgentVersions({}, context)
Input
- input
object
- ConfigurationManager StackConfigurationManager
- StackId String
Output
- output DescribeAgentVersionsResult
DescribeApps
amazonaws_opsworks.DescribeApps({}, context)
Input
Output
- output DescribeAppsResult
DescribeCommands
amazonaws_opsworks.DescribeCommands({}, context)
Input
Output
- output DescribeCommandsResult
DescribeDeployments
amazonaws_opsworks.DescribeDeployments({}, context)
Input
Output
- output DescribeDeploymentsResult
DescribeEcsClusters
amazonaws_opsworks.DescribeEcsClusters({}, context)
Input
- input
object
Output
- output DescribeEcsClustersResult
DescribeElasticIps
amazonaws_opsworks.DescribeElasticIps({}, context)
Input
Output
- output DescribeElasticIpsResult
DescribeElasticLoadBalancers
amazonaws_opsworks.DescribeElasticLoadBalancers({}, context)
Input
Output
DescribeInstances
amazonaws_opsworks.DescribeInstances({}, context)
Input
Output
- output DescribeInstancesResult
DescribeLayers
amazonaws_opsworks.DescribeLayers({}, context)
Input
Output
- output DescribeLayersResult
DescribeLoadBasedAutoScaling
amazonaws_opsworks.DescribeLoadBasedAutoScaling({
"LayerIds": []
}, context)
Input
- input
object
- LayerIds required Strings
Output
DescribeMyUserProfile
amazonaws_opsworks.DescribeMyUserProfile({}, context)
Input
- input
object
Output
- output DescribeMyUserProfileResult
DescribeOperatingSystems
amazonaws_opsworks.DescribeOperatingSystems({}, context)
Input
- input
object
Output
DescribePermissions
amazonaws_opsworks.DescribePermissions({}, context)
Input
Output
- output DescribePermissionsResult
DescribeRaidArrays
amazonaws_opsworks.DescribeRaidArrays({}, context)
Input
Output
- output DescribeRaidArraysResult
DescribeRdsDbInstances
amazonaws_opsworks.DescribeRdsDbInstances({
"StackId": ""
}, context)
Input
Output
- output DescribeRdsDbInstancesResult
DescribeServiceErrors
amazonaws_opsworks.DescribeServiceErrors({}, context)
Input
Output
- output DescribeServiceErrorsResult
DescribeStackProvisioningParameters
amazonaws_opsworks.DescribeStackProvisioningParameters({
"StackId": ""
}, context)
Input
- input
object
- StackId required String
Output
DescribeStackSummary
amazonaws_opsworks.DescribeStackSummary({
"StackId": ""
}, context)
Input
- input
object
- StackId required String
Output
- output DescribeStackSummaryResult
DescribeStacks
amazonaws_opsworks.DescribeStacks({}, context)
Input
- input
object
- StackIds Strings
Output
- output DescribeStacksResult
DescribeTimeBasedAutoScaling
amazonaws_opsworks.DescribeTimeBasedAutoScaling({
"InstanceIds": []
}, context)
Input
- input
object
- InstanceIds required Strings
Output
DescribeUserProfiles
amazonaws_opsworks.DescribeUserProfiles({}, context)
Input
- input
object
- IamUserArns Strings
Output
- output DescribeUserProfilesResult
DescribeVolumes
amazonaws_opsworks.DescribeVolumes({}, context)
Input
Output
- output DescribeVolumesResult
DetachElasticLoadBalancer
amazonaws_opsworks.DetachElasticLoadBalancer({
"ElasticLoadBalancerName": "",
"LayerId": ""
}, context)
Input
Output
Output schema unknown
DisassociateElasticIp
amazonaws_opsworks.DisassociateElasticIp({
"ElasticIp": ""
}, context)
Input
- input
object
- ElasticIp required String
Output
Output schema unknown
GetHostnameSuggestion
amazonaws_opsworks.GetHostnameSuggestion({
"LayerId": ""
}, context)
Input
- input
object
- LayerId required String
Output
- output GetHostnameSuggestionResult
GrantAccess
amazonaws_opsworks.GrantAccess({
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required String
- ValidForInMinutes ValidForInMinutes
Output
- output GrantAccessResult
ListTags
amazonaws_opsworks.ListTags({
"ResourceArn": ""
}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken NextToken
- ResourceArn required ResourceArn
Output
- output ListTagsResult
RebootInstance
amazonaws_opsworks.RebootInstance({
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required String
Output
Output schema unknown
RegisterEcsCluster
amazonaws_opsworks.RegisterEcsCluster({
"EcsClusterArn": "",
"StackId": ""
}, context)
Input
Output
- output RegisterEcsClusterResult
RegisterElasticIp
amazonaws_opsworks.RegisterElasticIp({
"ElasticIp": "",
"StackId": ""
}, context)
Input
Output
- output RegisterElasticIpResult
RegisterInstance
amazonaws_opsworks.RegisterInstance({
"StackId": ""
}, context)
Input
- input
object
Output
- output RegisterInstanceResult
RegisterRdsDbInstance
amazonaws_opsworks.RegisterRdsDbInstance({
"StackId": "",
"RdsDbInstanceArn": "",
"DbUser": "",
"DbPassword": ""
}, context)
Input
- input
object
Output
Output schema unknown
RegisterVolume
amazonaws_opsworks.RegisterVolume({
"StackId": ""
}, context)
Input
Output
- output RegisterVolumeResult
SetLoadBasedAutoScaling
amazonaws_opsworks.SetLoadBasedAutoScaling({
"LayerId": ""
}, context)
Input
- input
object
- DownScaling AutoScalingThresholds
- Enable Boolean
- LayerId required String
- UpScaling AutoScalingThresholds
Output
Output schema unknown
SetPermission
amazonaws_opsworks.SetPermission({
"StackId": "",
"IamUserArn": ""
}, context)
Input
- input
object
Output
Output schema unknown
SetTimeBasedAutoScaling
amazonaws_opsworks.SetTimeBasedAutoScaling({
"InstanceId": ""
}, context)
Input
- input
object
- AutoScalingSchedule WeeklyAutoScalingSchedule
- InstanceId required String
Output
Output schema unknown
StartInstance
amazonaws_opsworks.StartInstance({
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required String
Output
Output schema unknown
StartStack
amazonaws_opsworks.StartStack({
"StackId": ""
}, context)
Input
- input
object
- StackId required String
Output
Output schema unknown
StopInstance
amazonaws_opsworks.StopInstance({
"InstanceId": ""
}, context)
Input
Output
Output schema unknown
StopStack
amazonaws_opsworks.StopStack({
"StackId": ""
}, context)
Input
- input
object
- StackId required String
Output
Output schema unknown
TagResource
amazonaws_opsworks.TagResource({
"ResourceArn": "",
"Tags": []
}, context)
Input
- input
object
- ResourceArn required ResourceArn
- Tags required Tags
Output
Output schema unknown
UnassignInstance
amazonaws_opsworks.UnassignInstance({
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required String
Output
Output schema unknown
UnassignVolume
amazonaws_opsworks.UnassignVolume({
"VolumeId": ""
}, context)
Input
- input
object
- VolumeId required String
Output
Output schema unknown
UntagResource
amazonaws_opsworks.UntagResource({
"ResourceArn": "",
"TagKeys": []
}, context)
Input
- input
object
- ResourceArn required ResourceArn
- TagKeys required TagKeys
Output
Output schema unknown
UpdateApp
amazonaws_opsworks.UpdateApp({
"AppId": ""
}, context)
Input
- input
object
- AppId required String
- AppSource Source
- Attributes AppAttributes
- DataSources DataSources
- Description String
- Domains Strings
- EnableSsl Boolean
- Environment EnvironmentVariables
- Name String
- SslConfiguration SslConfiguration
- Type AppType
Output
Output schema unknown
UpdateElasticIp
amazonaws_opsworks.UpdateElasticIp({
"ElasticIp": ""
}, context)
Input
Output
Output schema unknown
UpdateInstance
amazonaws_opsworks.UpdateInstance({
"InstanceId": ""
}, context)
Input
- input
object
Output
Output schema unknown
UpdateLayer
amazonaws_opsworks.UpdateLayer({
"LayerId": ""
}, context)
Input
- input
object
- Attributes LayerAttributes
- AutoAssignElasticIps Boolean
- AutoAssignPublicIps Boolean
- CloudWatchLogsConfiguration CloudWatchLogsConfiguration
- CustomInstanceProfileArn String
- CustomJson String
- CustomRecipes Recipes
- CustomSecurityGroupIds Strings
- EnableAutoHealing Boolean
- InstallUpdatesOnBoot Boolean
- LayerId required String
- LifecycleEventConfiguration LifecycleEventConfiguration
- Name String
- Packages Strings
- Shortname String
- UseEbsOptimizedInstances Boolean
- VolumeConfigurations VolumeConfigurations
Output
Output schema unknown
UpdateMyUserProfile
amazonaws_opsworks.UpdateMyUserProfile({}, context)
Input
- input
object
- SshPublicKey String
Output
Output schema unknown
UpdateRdsDbInstance
amazonaws_opsworks.UpdateRdsDbInstance({
"RdsDbInstanceArn": ""
}, context)
Input
Output
Output schema unknown
UpdateStack
amazonaws_opsworks.UpdateStack({
"StackId": ""
}, context)
Input
- input
object
- AgentVersion String
- Attributes StackAttributes
- ChefConfiguration ChefConfiguration
- ConfigurationManager StackConfigurationManager
- CustomCookbooksSource Source
- CustomJson String
- DefaultAvailabilityZone String
- DefaultInstanceProfileArn String
- DefaultOs String
- DefaultRootDeviceType RootDeviceType
- DefaultSshKeyName String
- DefaultSubnetId String
- HostnameTheme String
- Name String
- ServiceRoleArn String
- StackId required String
- UseCustomCookbooks Boolean
- UseOpsworksSecurityGroups Boolean
Output
Output schema unknown
UpdateUserProfile
amazonaws_opsworks.UpdateUserProfile({
"IamUserArn": ""
}, context)
Input
- input
object
Output
Output schema unknown
UpdateVolume
amazonaws_opsworks.UpdateVolume({
"VolumeId": ""
}, context)
Input
Output
Output schema unknown
Definitions
AgentVersion
- AgentVersion
object
: Describes an agent version.- ConfigurationManager StackConfigurationManager
- Version String
AgentVersions
- AgentVersions
array
- items AgentVersion
App
- App
object
: A description of the app.- AppId String
- AppSource Source
- Attributes AppAttributes
- CreatedAt String
- DataSources DataSources
- Description String
- Domains Strings
- EnableSsl Boolean
- Environment EnvironmentVariables
- Name String
- Shortname String
- SslConfiguration SslConfiguration
- StackId String
- Type AppType
AppAttributes
- AppAttributes
array
- items
object
- key AppAttributesKeys
- value String
- items
AppAttributesKeys
- AppAttributesKeys
string
(values: DocumentRoot, RailsEnv, AutoBundleOnDeploy, AwsFlowRubySettings)
AppType
- AppType
string
(values: aws-flow-ruby, java, rails, php, nodejs, static, other)
Apps
- Apps
array
- items App
Architecture
- Architecture
string
(values: x86_64, i386)
AssignInstanceRequest
AssignVolumeRequest
AssociateElasticIpRequest
AttachElasticLoadBalancerRequest
- AttachElasticLoadBalancerRequest
object
AutoScalingThresholds
- AutoScalingThresholds
object
: Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances.
AutoScalingType
- AutoScalingType
string
(values: load, timer)
BlockDeviceMapping
- BlockDeviceMapping
object
: Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.- DeviceName String
- Ebs EbsBlockDevice
- NoDevice String
- VirtualName String
BlockDeviceMappings
- BlockDeviceMappings
array
- items BlockDeviceMapping
Boolean
- Boolean
boolean
ChefConfiguration
- ChefConfiguration
object
: Describes the Chef configuration.
CloneStackRequest
- CloneStackRequest
object
- AgentVersion String
- Attributes StackAttributes
- ChefConfiguration ChefConfiguration
- CloneAppIds Strings
- ClonePermissions Boolean
- ConfigurationManager StackConfigurationManager
- CustomCookbooksSource Source
- CustomJson String
- DefaultAvailabilityZone String
- DefaultInstanceProfileArn String
- DefaultOs String
- DefaultRootDeviceType RootDeviceType
- DefaultSshKeyName String
- DefaultSubnetId String
- HostnameTheme String
- Name String
- Region String
- ServiceRoleArn required String
- SourceStackId required String
- UseCustomCookbooks Boolean
- UseOpsworksSecurityGroups Boolean
- VpcId String
CloneStackResult
- CloneStackResult
object
: Contains the response to a CloneStack request.- StackId String
CloudWatchLogsConfiguration
- CloudWatchLogsConfiguration
object
: Describes the Amazon CloudWatch logs configuration for a layer.- Enabled Boolean
- LogStreams CloudWatchLogsLogStreams
CloudWatchLogsEncoding
- CloudWatchLogsEncoding
string
(values: ascii, big5, big5hkscs, cp037, cp424, cp437, cp500, cp720, cp737, cp775, cp850, cp852, cp855, cp856, cp857, cp858, cp860, cp861, cp862, cp863, cp864, cp865, cp866, cp869, cp874, cp875, cp932, cp949, cp950, cp1006, cp1026, cp1140, cp1250, cp1251, cp1252, cp1253, cp1254, cp1255, cp1256, cp1257, cp1258, euc_jp, euc_jis_2004, euc_jisx0213, euc_kr, gb2312, gbk, gb18030, hz, iso2022_jp, iso2022_jp_1, iso2022_jp_2, iso2022_jp_2004, iso2022_jp_3, iso2022_jp_ext, iso2022_kr, latin_1, iso8859_2, iso8859_3, iso8859_4, iso8859_5, iso8859_6, iso8859_7, iso8859_8, iso8859_9, iso8859_10, iso8859_13, iso8859_14, iso8859_15, iso8859_16, johab, koi8_r, koi8_u, mac_cyrillic, mac_greek, mac_iceland, mac_latin2, mac_roman, mac_turkish, ptcp154, shift_jis, shift_jis_2004, shift_jisx0213, utf_32, utf_32_be, utf_32_le, utf_16, utf_16_be, utf_16_le, utf_7, utf_8, utf_8_sig): 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.
CloudWatchLogsInitialPosition
- CloudWatchLogsInitialPosition
string
(values: start_of_file, end_of_file): Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. It's only used if there is no state persisted for that log stream.
CloudWatchLogsLogStream
- CloudWatchLogsLogStream
object
: Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.- BatchCount Integer
- BatchSize Integer
- BufferDuration Integer
- DatetimeFormat String
- Encoding CloudWatchLogsEncoding
- File String
- FileFingerprintLines String
- InitialPosition CloudWatchLogsInitialPosition
- LogGroupName String
- MultiLineStartPattern String
- TimeZone CloudWatchLogsTimeZone
CloudWatchLogsLogStreams
- CloudWatchLogsLogStreams
array
: Describes the Amazon CloudWatch logs configuration for a layer.- items CloudWatchLogsLogStream
CloudWatchLogsTimeZone
- CloudWatchLogsTimeZone
string
(values: LOCAL, UTC): The preferred time zone for logs streamed to CloudWatch Logs. Valid values are LOCAL and UTC, for Coordinated Universal Time.
Command
- Command
object
: Describes a command.
Commands
- Commands
array
- items Command
CreateAppRequest
- CreateAppRequest
object
- AppSource Source
- Attributes AppAttributes
- DataSources DataSources
- Description String
- Domains Strings
- EnableSsl Boolean
- Environment EnvironmentVariables
- Name required String
- Shortname String
- SslConfiguration SslConfiguration
- StackId required String
- Type required AppType
CreateAppResult
- CreateAppResult
object
: Contains the response to a CreateApp request.- AppId String
CreateDeploymentRequest
- CreateDeploymentRequest
object
CreateDeploymentResult
- CreateDeploymentResult
object
: Contains the response to a CreateDeployment request.- DeploymentId String
CreateInstanceRequest
- CreateInstanceRequest
object
- AgentVersion String
- AmiId String
- Architecture Architecture
- AutoScalingType AutoScalingType
- AvailabilityZone String
- BlockDeviceMappings BlockDeviceMappings
- EbsOptimized Boolean
- Hostname String
- InstallUpdatesOnBoot Boolean
- InstanceType required String
- LayerIds required Strings
- Os String
- RootDeviceType RootDeviceType
- SshKeyName String
- StackId required String
- SubnetId String
- Tenancy String
- VirtualizationType String
CreateInstanceResult
- CreateInstanceResult
object
: Contains the response to a CreateInstance request.- InstanceId String
CreateLayerRequest
- CreateLayerRequest
object
- Attributes LayerAttributes
- AutoAssignElasticIps Boolean
- AutoAssignPublicIps Boolean
- CloudWatchLogsConfiguration CloudWatchLogsConfiguration
- CustomInstanceProfileArn String
- CustomJson String
- CustomRecipes Recipes
- CustomSecurityGroupIds Strings
- EnableAutoHealing Boolean
- InstallUpdatesOnBoot Boolean
- LifecycleEventConfiguration LifecycleEventConfiguration
- Name required String
- Packages Strings
- Shortname required String
- StackId required String
- Type required LayerType
- UseEbsOptimizedInstances Boolean
- VolumeConfigurations VolumeConfigurations
CreateLayerResult
- CreateLayerResult
object
: Contains the response to a CreateLayer request.- LayerId String
CreateStackRequest
- CreateStackRequest
object
- AgentVersion String
- Attributes StackAttributes
- ChefConfiguration ChefConfiguration
- ConfigurationManager StackConfigurationManager
- CustomCookbooksSource Source
- CustomJson String
- DefaultAvailabilityZone String
- DefaultInstanceProfileArn required String
- DefaultOs String
- DefaultRootDeviceType RootDeviceType
- DefaultSshKeyName String
- DefaultSubnetId String
- HostnameTheme String
- Name required String
- Region required String
- ServiceRoleArn required String
- UseCustomCookbooks Boolean
- UseOpsworksSecurityGroups Boolean
- VpcId String
CreateStackResult
- CreateStackResult
object
: Contains the response to a CreateStack request.- StackId String
CreateUserProfileRequest
- CreateUserProfileRequest
object
CreateUserProfileResult
- CreateUserProfileResult
object
: Contains the response to a CreateUserProfile request.- IamUserArn String
DailyAutoScalingSchedule
DataSource
DataSources
- DataSources
array
- items DataSource
DateTime
- DateTime
string
DeleteAppRequest
- DeleteAppRequest
object
- AppId required String
DeleteInstanceRequest
DeleteLayerRequest
- DeleteLayerRequest
object
- LayerId required String
DeleteStackRequest
- DeleteStackRequest
object
- StackId required String
DeleteUserProfileRequest
- DeleteUserProfileRequest
object
- IamUserArn required String
Deployment
- Deployment
object
: Describes a deployment of a stack or app.
DeploymentCommand
- DeploymentCommand
object
: Used to specify a stack or deployment command.- Args DeploymentCommandArgs
- Name required DeploymentCommandName
DeploymentCommandArgs
DeploymentCommandName
- DeploymentCommandName
string
(values: install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, configure, setup, deploy, rollback, start, stop, restart, undeploy)
Deployments
- Deployments
array
- items Deployment
DeregisterEcsClusterRequest
- DeregisterEcsClusterRequest
object
- EcsClusterArn required String
DeregisterElasticIpRequest
- DeregisterElasticIpRequest
object
- ElasticIp required String
DeregisterInstanceRequest
- DeregisterInstanceRequest
object
- InstanceId required String
DeregisterRdsDbInstanceRequest
- DeregisterRdsDbInstanceRequest
object
- RdsDbInstanceArn required String
DeregisterVolumeRequest
- DeregisterVolumeRequest
object
- VolumeId required String
DescribeAgentVersionsRequest
- DescribeAgentVersionsRequest
object
- ConfigurationManager StackConfigurationManager
- StackId String
DescribeAgentVersionsResult
- DescribeAgentVersionsResult
object
: Contains the response to a DescribeAgentVersions request.- AgentVersions AgentVersions
DescribeAppsRequest
DescribeAppsResult
- DescribeAppsResult
object
: Contains the response to a DescribeApps request.- Apps Apps
DescribeCommandsRequest
DescribeCommandsResult
- DescribeCommandsResult
object
: Contains the response to a DescribeCommands request.- Commands Commands
DescribeDeploymentsRequest
DescribeDeploymentsResult
- DescribeDeploymentsResult
object
: Contains the response to a DescribeDeployments request.- Deployments Deployments
DescribeEcsClustersRequest
- DescribeEcsClustersRequest
object
DescribeEcsClustersResult
- DescribeEcsClustersResult
object
: Contains the response to a DescribeEcsClusters request.- EcsClusters EcsClusters
- NextToken String
DescribeElasticIpsRequest
DescribeElasticIpsResult
- DescribeElasticIpsResult
object
: Contains the response to a DescribeElasticIps request.- ElasticIps ElasticIps
DescribeElasticLoadBalancersRequest
DescribeElasticLoadBalancersResult
- DescribeElasticLoadBalancersResult
object
: Contains the response to a DescribeElasticLoadBalancers request.- ElasticLoadBalancers ElasticLoadBalancers
DescribeInstancesRequest
DescribeInstancesResult
- DescribeInstancesResult
object
: Contains the response to a DescribeInstances request.- Instances Instances
DescribeLayersRequest
DescribeLayersResult
- DescribeLayersResult
object
: Contains the response to a DescribeLayers request.- Layers Layers
DescribeLoadBasedAutoScalingRequest
- DescribeLoadBasedAutoScalingRequest
object
- LayerIds required Strings
DescribeLoadBasedAutoScalingResult
- DescribeLoadBasedAutoScalingResult
object
: Contains the response to a DescribeLoadBasedAutoScaling request.- LoadBasedAutoScalingConfigurations LoadBasedAutoScalingConfigurations
DescribeMyUserProfileResult
- DescribeMyUserProfileResult
object
: Contains the response to a DescribeMyUserProfile request.- UserProfile SelfUserProfile
DescribeOperatingSystemsResponse
- DescribeOperatingSystemsResponse
object
: The response to a DescribeOperatingSystems request.- OperatingSystems OperatingSystems
DescribePermissionsRequest
DescribePermissionsResult
- DescribePermissionsResult
object
: Contains the response to a DescribePermissions request.- Permissions Permissions
DescribeRaidArraysRequest
DescribeRaidArraysResult
- DescribeRaidArraysResult
object
: Contains the response to a DescribeRaidArrays request.- RaidArrays RaidArrays
DescribeRdsDbInstancesRequest
DescribeRdsDbInstancesResult
- DescribeRdsDbInstancesResult
object
: Contains the response to a DescribeRdsDbInstances request.- RdsDbInstances RdsDbInstances
DescribeServiceErrorsRequest
DescribeServiceErrorsResult
- DescribeServiceErrorsResult
object
: Contains the response to a DescribeServiceErrors request.- ServiceErrors ServiceErrors
DescribeStackProvisioningParametersRequest
- DescribeStackProvisioningParametersRequest
object
- StackId required String
DescribeStackProvisioningParametersResult
- DescribeStackProvisioningParametersResult
object
: Contains the response to a DescribeStackProvisioningParameters request.- AgentInstallerUrl String
- Parameters Parameters
DescribeStackSummaryRequest
- DescribeStackSummaryRequest
object
- StackId required String
DescribeStackSummaryResult
- DescribeStackSummaryResult
object
: Contains the response to a DescribeStackSummary request.- StackSummary StackSummary
DescribeStacksRequest
- DescribeStacksRequest
object
- StackIds Strings
DescribeStacksResult
- DescribeStacksResult
object
: Contains the response to a DescribeStacks request.- Stacks Stacks
DescribeTimeBasedAutoScalingRequest
- DescribeTimeBasedAutoScalingRequest
object
- InstanceIds required Strings
DescribeTimeBasedAutoScalingResult
- DescribeTimeBasedAutoScalingResult
object
: Contains the response to a DescribeTimeBasedAutoScaling request.- TimeBasedAutoScalingConfigurations TimeBasedAutoScalingConfigurations
DescribeUserProfilesRequest
- DescribeUserProfilesRequest
object
- IamUserArns Strings
DescribeUserProfilesResult
- DescribeUserProfilesResult
object
: Contains the response to a DescribeUserProfiles request.- UserProfiles UserProfiles
DescribeVolumesRequest
DescribeVolumesResult
- DescribeVolumesResult
object
: Contains the response to a DescribeVolumes request.- Volumes Volumes
DetachElasticLoadBalancerRequest
- DetachElasticLoadBalancerRequest
object
DisassociateElasticIpRequest
- DisassociateElasticIpRequest
object
- ElasticIp required String
Double
- Double
number
EbsBlockDevice
- EbsBlockDevice
object
: Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.- DeleteOnTermination Boolean
- Iops Integer
- SnapshotId String
- VolumeSize Integer
- VolumeType VolumeType
EcsCluster
- EcsCluster
object
: Describes a registered Amazon ECS cluster.
EcsClusters
- EcsClusters
array
- items EcsCluster
ElasticIp
- ElasticIp
object
: Describes an Elastic IP address.
ElasticIps
- ElasticIps
array
- items ElasticIp
ElasticLoadBalancer
- ElasticLoadBalancer
object
: Describes an Elastic Load Balancing instance.
ElasticLoadBalancers
- ElasticLoadBalancers
array
- items ElasticLoadBalancer
EnvironmentVariable
- EnvironmentVariable
object
: Represents an app's environment variable.
EnvironmentVariables
- EnvironmentVariables
array
- items EnvironmentVariable
GetHostnameSuggestionRequest
- GetHostnameSuggestionRequest
object
- LayerId required String
GetHostnameSuggestionResult
- GetHostnameSuggestionResult
object
: Contains the response to a GetHostnameSuggestion request.
GrantAccessRequest
- GrantAccessRequest
object
- InstanceId required String
- ValidForInMinutes ValidForInMinutes
GrantAccessResult
- GrantAccessResult
object
: Contains the response to a GrantAccess request.- TemporaryCredential TemporaryCredential
Hour
- Hour
string
Instance
- Instance
object
: Describes an instance.- AgentVersion String
- AmiId String
- Architecture Architecture
- Arn String
- AutoScalingType AutoScalingType
- AvailabilityZone String
- BlockDeviceMappings BlockDeviceMappings
- CreatedAt DateTime
- EbsOptimized Boolean
- Ec2InstanceId String
- EcsClusterArn String
- EcsContainerInstanceArn String
- ElasticIp String
- Hostname String
- InfrastructureClass String
- InstallUpdatesOnBoot Boolean
- InstanceId String
- InstanceProfileArn String
- InstanceType String
- LastServiceErrorId String
- LayerIds Strings
- Os String
- Platform String
- PrivateDns String
- PrivateIp String
- PublicDns String
- PublicIp String
- RegisteredBy String
- ReportedAgentVersion String
- ReportedOs ReportedOs
- RootDeviceType RootDeviceType
- RootDeviceVolumeId String
- SecurityGroupIds Strings
- SshHostDsaKeyFingerprint String
- SshHostRsaKeyFingerprint String
- SshKeyName String
- StackId String
- Status String
- SubnetId String
- Tenancy String
- VirtualizationType VirtualizationType
InstanceIdentity
- InstanceIdentity
object
: Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.
Instances
- Instances
array
- items Instance
InstancesCount
- InstancesCount
object
: Describes how many instances a stack has for each status.- Assigning Integer
- Booting Integer
- ConnectionLost Integer
- Deregistering Integer
- Online Integer
- Pending Integer
- Rebooting Integer
- Registered Integer
- Registering Integer
- Requested Integer
- RunningSetup Integer
- SetupFailed Integer
- ShuttingDown Integer
- StartFailed Integer
- StopFailed Integer
- Stopped Integer
- Stopping Integer
- Terminated Integer
- Terminating Integer
- Unassigning Integer
Integer
- Integer
integer
Layer
- Layer
object
: Describes a layer.- Arn String
- Attributes LayerAttributes
- AutoAssignElasticIps Boolean
- AutoAssignPublicIps Boolean
- CloudWatchLogsConfiguration CloudWatchLogsConfiguration
- CreatedAt DateTime
- CustomInstanceProfileArn String
- CustomJson String
- CustomRecipes Recipes
- CustomSecurityGroupIds Strings
- DefaultRecipes Recipes
- DefaultSecurityGroupNames Strings
- EnableAutoHealing Boolean
- InstallUpdatesOnBoot Boolean
- LayerId String
- LifecycleEventConfiguration LifecycleEventConfiguration
- Name String
- Packages Strings
- Shortname String
- StackId String
- Type LayerType
- UseEbsOptimizedInstances Boolean
- VolumeConfigurations VolumeConfigurations
LayerAttributes
- LayerAttributes
array
- items
object
- key LayerAttributesKeys
- value String
- items
LayerAttributesKeys
- LayerAttributesKeys
string
(values: EcsClusterArn, EnableHaproxyStats, HaproxyStatsUrl, HaproxyStatsUser, HaproxyStatsPassword, HaproxyHealthCheckUrl, HaproxyHealthCheckMethod, MysqlRootPassword, MysqlRootPasswordUbiquitous, GangliaUrl, GangliaUser, GangliaPassword, MemcachedMemory, NodejsVersion, RubyVersion, RubygemsVersion, ManageBundler, BundlerVersion, RailsStack, PassengerVersion, Jvm, JvmVersion, JvmOptions, JavaAppServer, JavaAppServerVersion)
LayerType
- LayerType
string
(values: aws-flow-ruby, ecs-cluster, java-app, lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom)
Layers
- Layers
array
- items Layer
LifecycleEventConfiguration
- LifecycleEventConfiguration
object
: Specifies the lifecycle event configuration- Shutdown ShutdownEventConfiguration
ListTagsRequest
- ListTagsRequest
object
- MaxResults MaxResults
- NextToken NextToken
- ResourceArn required ResourceArn
ListTagsResult
LoadBasedAutoScalingConfiguration
- LoadBasedAutoScalingConfiguration
object
: Describes a layer's load-based auto scaling configuration.- DownScaling AutoScalingThresholds
- Enable Boolean
- LayerId String
- UpScaling AutoScalingThresholds
LoadBasedAutoScalingConfigurations
- LoadBasedAutoScalingConfigurations
array
MaxResults
- MaxResults
integer
Minute
- Minute
integer
NextToken
- NextToken
string
OperatingSystem
- OperatingSystem
object
: Describes supported operating systems in AWS OpsWorks Stacks.
OperatingSystemConfigurationManager
- OperatingSystemConfigurationManager
object
: A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.
OperatingSystemConfigurationManagers
- OperatingSystemConfigurationManagers
array
OperatingSystems
- OperatingSystems
array
- items OperatingSystem
Parameters
Permission
- Permission
object
: Describes stack or user permissions.
Permissions
- Permissions
array
- items Permission
RaidArray
- RaidArray
object
: Describes an instance's RAID array.
RaidArrays
- RaidArrays
array
- items RaidArray
RdsDbInstance
- RdsDbInstance
object
: Describes an Amazon RDS instance.
RdsDbInstances
- RdsDbInstances
array
- items RdsDbInstance
RebootInstanceRequest
- RebootInstanceRequest
object
- InstanceId required String
Recipes
- Recipes
object
: AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS 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. AWS 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.
RegisterEcsClusterRequest
RegisterEcsClusterResult
- RegisterEcsClusterResult
object
: Contains the response to a RegisterEcsCluster request.- EcsClusterArn String
RegisterElasticIpRequest
RegisterElasticIpResult
- RegisterElasticIpResult
object
: Contains the response to a RegisterElasticIp request.- ElasticIp String
RegisterInstanceRequest
- RegisterInstanceRequest
object
- Hostname [String](#strin