Assign a registered instance to a layer.
You can assign registered on-premises instances to any layer type.
You can assign registered Amazon EC2 instances only to custom layers.
You cannot use this action with instances that were created with OpsWorks Stacks.
Required Permissions: To use this action, an Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "AssignVolume": { "name": "AssignVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssignVolumeRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "AssociateElasticIp": { "name": "AssociateElasticIp", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateElasticIpRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "AttachElasticLoadBalancer": { "name": "AttachElasticLoadBalancer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AttachElasticLoadBalancerRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see the Elastic Load Balancing Developer Guide.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "CloneStack": { "name": "CloneStack", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CloneStackRequest" }, "output": { "shape": "CloneStackResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "CreateApp": { "name": "CreateApp", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateAppRequest" }, "output": { "shape": "CreateAppResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Creates an app for a specified stack. For more information, see Creating Apps.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "CreateDeployment": { "name": "CreateDeployment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateDeploymentRequest" }, "output": { "shape": "CreateDeploymentResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "CreateInstance": { "name": "CreateInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateInstanceRequest" }, "output": { "shape": "CreateInstanceResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "CreateLayer": { "name": "CreateLayer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateLayerRequest" }, "output": { "shape": "CreateLayerResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Creates a layer. For more information, see How to Create a Layer.
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "CreateStack": { "name": "CreateStack", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateStackRequest" }, "output": { "shape": "CreateStackResult" }, "errors": [ { "shape": "ValidationException" } ], "documentation": "Creates a new stack. For more information, see Create a New Stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "CreateUserProfile": { "name": "CreateUserProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateUserProfileRequest" }, "output": { "shape": "CreateUserProfileResult" }, "errors": [ { "shape": "ValidationException" } ], "documentation": "Creates a new user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DeleteApp": { "name": "DeleteApp", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteAppRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deletes a specified app.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DeleteInstance": { "name": "DeleteInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
For more information, see Deleting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DeleteLayer": { "name": "DeleteLayer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteLayerRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DeleteStack": { "name": "DeleteStack", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteStackRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DeleteUserProfile": { "name": "DeleteUserProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteUserProfileRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deletes a user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DeregisterEcsCluster": { "name": "DeregisterEcsCluster", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterEcsClusterRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
" }, "DeregisterElasticIp": { "name": "DeregisterElasticIp", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterElasticIpRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deregisters a specified Elastic IP address. The address can be registered by another stack after it is deregistered. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DeregisterInstance": { "name": "DeregisterInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the instance from the stack and returns it to your control.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DeregisterRdsDbInstance": { "name": "DeregisterRdsDbInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterRdsDbInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deregisters an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DeregisterVolume": { "name": "DeregisterVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterVolumeRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DescribeAgentVersions": { "name": "DescribeAgentVersions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeAgentVersionsRequest" }, "output": { "shape": "DescribeAgentVersionsResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.
Requests a description of a specified set of apps.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeCommands": { "name": "DescribeCommands", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeCommandsRequest" }, "output": { "shape": "DescribeCommandsResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes the results of specified commands.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeDeployments": { "name": "DescribeDeployments", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeDeploymentsRequest" }, "output": { "shape": "DescribeDeploymentsResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Requests a description of a specified set of deployments.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeEcsClusters": { "name": "DescribeEcsClusters", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEcsClustersRequest" }, "output": { "shape": "DescribeEcsClustersResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
" }, "DescribeElasticIps": { "name": "DescribeElasticIps", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeElasticIpsRequest" }, "output": { "shape": "DescribeElasticIpsResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes Elastic IP addresses.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeElasticLoadBalancers": { "name": "DescribeElasticLoadBalancers", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeElasticLoadBalancersRequest" }, "output": { "shape": "DescribeElasticLoadBalancersResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes a stack's Elastic Load Balancing instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeInstances": { "name": "DescribeInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeInstancesRequest" }, "output": { "shape": "DescribeInstancesResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Requests a description of a set of instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeLayers": { "name": "DescribeLayers", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLayersRequest" }, "output": { "shape": "DescribeLayersResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Requests a description of one or more layers in a specified stack.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeLoadBasedAutoScaling": { "name": "DescribeLoadBasedAutoScaling", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLoadBasedAutoScalingRequest" }, "output": { "shape": "DescribeLoadBasedAutoScalingResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes load-based auto scaling configurations for specified layers.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeMyUserProfile": { "name": "DescribeMyUserProfile", "http": { "method": "POST", "requestUri": "/" }, "output": { "shape": "DescribeMyUserProfileResult" }, "documentation": "Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeOperatingSystems": { "name": "DescribeOperatingSystems", "http": { "method": "POST", "requestUri": "/" }, "output": { "shape": "DescribeOperatingSystemsResponse" }, "documentation": "Describes the operating systems that are supported by OpsWorks Stacks.
" }, "DescribePermissions": { "name": "DescribePermissions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribePermissionsRequest" }, "output": { "shape": "DescribePermissionsResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes the permissions for a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DescribeRaidArrays": { "name": "DescribeRaidArrays", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeRaidArraysRequest" }, "output": { "shape": "DescribeRaidArraysResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describe an instance's RAID arrays.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeRdsDbInstances": { "name": "DescribeRdsDbInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeRdsDbInstancesRequest" }, "output": { "shape": "DescribeRdsDbInstancesResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes Amazon RDS instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
" }, "DescribeServiceErrors": { "name": "DescribeServiceErrors", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeServiceErrorsRequest" }, "output": { "shape": "DescribeServiceErrorsResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes OpsWorks Stacks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
" }, "DescribeStackProvisioningParameters": { "name": "DescribeStackProvisioningParameters", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeStackProvisioningParametersRequest" }, "output": { "shape": "DescribeStackProvisioningParametersResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Requests a description of a stack's provisioning parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeStackSummary": { "name": "DescribeStackSummary", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeStackSummaryRequest" }, "output": { "shape": "DescribeStackSummaryResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeStacks": { "name": "DescribeStacks", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeStacksRequest" }, "output": { "shape": "DescribeStacksResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeTimeBasedAutoScaling": { "name": "DescribeTimeBasedAutoScaling", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTimeBasedAutoScalingRequest" }, "output": { "shape": "DescribeTimeBasedAutoScalingResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes time-based auto scaling configurations for specified instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeUserProfiles": { "name": "DescribeUserProfiles", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeUserProfilesRequest" }, "output": { "shape": "DescribeUserProfilesResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DescribeVolumes": { "name": "DescribeVolumes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVolumesRequest" }, "output": { "shape": "DescribeVolumesResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Describes an instance's Amazon EBS volumes.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "DetachElasticLoadBalancer": { "name": "DetachElasticLoadBalancer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DetachElasticLoadBalancerRequest" }, "errors": [ { "shape": "ResourceNotFoundException" } ], "documentation": "Detaches a specified Elastic Load Balancing instance from its layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "DisassociateElasticIp": { "name": "DisassociateElasticIp", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateElasticIpRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "GetHostnameSuggestion": { "name": "GetHostnameSuggestion", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetHostnameSuggestionRequest" }, "output": { "shape": "GetHostnameSuggestionResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "GrantAccess": { "name": "GrantAccess", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GrantAccessRequest" }, "output": { "shape": "GrantAccessResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
" }, "ListTags": { "name": "ListTags", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsRequest" }, "output": { "shape": "ListTagsResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Returns a list of tags that are applied to the specified stack or layer.
" }, "RebootInstance": { "name": "RebootInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RebootInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "RegisterEcsCluster": { "name": "RegisterEcsCluster", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterEcsClusterRequest" }, "output": { "shape": "RegisterEcsClusterResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "RegisterElasticIp": { "name": "RegisterElasticIp", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterElasticIpRequest" }, "output": { "shape": "RegisterElasticIpResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "RegisterInstance": { "name": "RegisterInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterInstanceRequest" }, "output": { "shape": "RegisterInstanceResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Registers instances that were created outside of OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "RegisterRdsDbInstance": { "name": "RegisterRdsDbInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterRdsDbInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Registers an Amazon RDS instance with a stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "RegisterVolume": { "name": "RegisterVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterVolumeRequest" }, "output": { "shape": "RegisterVolumeResult" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "SetLoadBasedAutoScaling": { "name": "SetLoadBasedAutoScaling", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetLoadBasedAutoScalingRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "SetPermission": { "name": "SetPermission", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetPermissionRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Specifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "SetTimeBasedAutoScaling": { "name": "SetTimeBasedAutoScaling", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetTimeBasedAutoScalingRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "StartInstance": { "name": "StartInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "StartStack": { "name": "StartStack", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartStackRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Starts a stack's instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "StopInstance": { "name": "StopInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "StopStack": { "name": "StopStack", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopStackRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Stops a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how tagging works, see Tags in the OpsWorks User Guide.
" }, "UnassignInstance": { "name": "UnassignInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UnassignInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "UnassignVolume": { "name": "UnassignVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UnassignVolumeRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UntagResourceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Removes tags from a specified stack or layer.
" }, "UpdateApp": { "name": "UpdateApp", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateAppRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates a specified app.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "UpdateElasticIp": { "name": "UpdateElasticIp", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateElasticIpRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates a registered Elastic IP address's name. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "UpdateInstance": { "name": "UpdateInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates a specified instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "UpdateLayer": { "name": "UpdateLayer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateLayerRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates a specified layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "UpdateMyUserProfile": { "name": "UpdateMyUserProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateMyUserProfileRequest" }, "errors": [ { "shape": "ValidationException" } ], "documentation": "Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "UpdateRdsDbInstance": { "name": "UpdateRdsDbInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateRdsDbInstanceRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "UpdateStack": { "name": "UpdateStack", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateStackRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" }, "UpdateUserProfile": { "name": "UpdateUserProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateUserProfileRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates a specified user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
" }, "UpdateVolume": { "name": "UpdateVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateVolumeRequest" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" } }, "shapes": { "AgentVersion": { "type": "structure", "members": { "Version": { "shape": "String", "documentation": "The agent version.
" }, "ConfigurationManager": { "shape": "StackConfigurationManager", "documentation": "The configuration manager.
" } }, "documentation": "Describes an agent version.
" }, "AgentVersions": { "type": "list", "member": { "shape": "AgentVersion" } }, "App": { "type": "structure", "members": { "AppId": { "shape": "String", "documentation": "The app ID.
" }, "StackId": { "shape": "String", "documentation": "The app stack ID.
" }, "Shortname": { "shape": "String", "documentation": "The app's short name.
" }, "Name": { "shape": "String", "documentation": "The app name.
" }, "Description": { "shape": "String", "documentation": "A description of the app.
" }, "DataSources": { "shape": "DataSources", "documentation": "The app's data sources.
" }, "Type": { "shape": "AppType", "documentation": "The app type.
" }, "AppSource": { "shape": "Source", "documentation": "A Source object that describes the app repository.
The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'
Whether to enable SSL for the app.
" }, "SslConfiguration": { "shape": "SslConfiguration", "documentation": "An SslConfiguration object with the SSL configuration.
The stack attributes.
" }, "CreatedAt": { "shape": "String", "documentation": "When the app was created.
" }, "Environment": { "shape": "EnvironmentVariables", "documentation": "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.
A description of the app.
" }, "AppAttributes": { "type": "map", "key": { "shape": "AppAttributesKeys" }, "value": { "shape": "String" } }, "AppAttributesKeys": { "type": "string", "enum": [ "DocumentRoot", "RailsEnv", "AutoBundleOnDeploy", "AwsFlowRubySettings" ] }, "AppType": { "type": "string", "enum": [ "aws-flow-ruby", "java", "rails", "php", "nodejs", "static", "other" ] }, "Apps": { "type": "list", "member": { "shape": "App" } }, "Architecture": { "type": "string", "enum": [ "x86_64", "i386" ] }, "AssignInstanceRequest": { "type": "structure", "required": [ "InstanceId", "LayerIds" ], "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" }, "LayerIds": { "shape": "Strings", "documentation": "The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.
" } } }, "AssignVolumeRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "VolumeId": { "shape": "String", "documentation": "The volume ID.
" }, "InstanceId": { "shape": "String", "documentation": "The instance ID.
" } } }, "AssociateElasticIpRequest": { "type": "structure", "required": [ "ElasticIp" ], "members": { "ElasticIp": { "shape": "String", "documentation": "The Elastic IP address.
" }, "InstanceId": { "shape": "String", "documentation": "The instance ID.
" } } }, "AttachElasticLoadBalancerRequest": { "type": "structure", "required": [ "ElasticLoadBalancerName", "LayerId" ], "members": { "ElasticLoadBalancerName": { "shape": "String", "documentation": "The Elastic Load Balancing instance's name.
" }, "LayerId": { "shape": "String", "documentation": "The ID of the layer to which the Elastic Load Balancing instance is to be attached.
" } } }, "AutoScalingThresholds": { "type": "structure", "members": { "InstanceCount": { "shape": "Integer", "documentation": "The number of instances to add or remove when the load exceeds a threshold.
" }, "ThresholdsWaitTime": { "shape": "Minute", "documentation": "The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
" }, "IgnoreMetricsTime": { "shape": "Minute", "documentation": "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.
The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
" }, "MemoryThreshold": { "shape": "Double", "documentation": "The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
" }, "LoadThreshold": { "shape": "Double", "documentation": "The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
" }, "Alarms": { "shape": "Strings", "documentation": "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.
Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when OpsWorks Stacks starts or stops load-based instances.
" }, "AutoScalingType": { "type": "string", "enum": [ "load", "timer" ] }, "BlockDeviceMapping": { "type": "structure", "members": { "DeviceName": { "shape": "String", "documentation": "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.
Suppresses the specified device included in the AMI's block device mapping.
" }, "VirtualName": { "shape": "String", "documentation": "The virtual device name. For more information, see BlockDeviceMapping.
" }, "Ebs": { "shape": "EbsBlockDevice", "documentation": "An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.
Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.
" }, "BlockDeviceMappings": { "type": "list", "member": { "shape": "BlockDeviceMapping" } }, "Boolean": { "type": "boolean", "box": true }, "ChefConfiguration": { "type": "structure", "members": { "ManageBerkshelf": { "shape": "Boolean", "documentation": "Whether to enable Berkshelf.
" }, "BerkshelfVersion": { "shape": "String", "documentation": "The Berkshelf version.
" } }, "documentation": "Describes the Chef configuration.
" }, "CloneStackRequest": { "type": "structure", "required": [ "SourceStackId", "ServiceRoleArn" ], "members": { "SourceStackId": { "shape": "String", "documentation": "The source stack ID.
" }, "Name": { "shape": "String", "documentation": "The cloned stack name. Stack names can be a maximum of 64 characters.
" }, "Region": { "shape": "String", "documentation": "The cloned stack Amazon Web Services Region, such as ap-northeast-2. For more information about Amazon Web Services Regions, see Regions and Endpoints.
The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.
If your account supports EC2 Classic, the default value is no VPC.
If your account does not support EC2 Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
It must belong to a VPC in your account that is in the specified region.
You must specify a value for DefaultSubnetId.
For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms.
" }, "Attributes": { "shape": "StackAttributes", "documentation": "A list of stack attributes and values as key/value pairs to be added to the cloned stack.
" }, "ServiceRoleArn": { "shape": "String", "documentation": "The stack Identity and Access Management (IAM) role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the OpsWorkss Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
The Amazon Resource Name (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.
" }, "DefaultOs": { "shape": "String", "documentation": "The stack's operating system, which must be set to one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.
The default option is the parent stack's operating system. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.
You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.
The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
" }, "ConfigurationManager": { "shape": "StackConfigurationManager", "documentation": "The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
" }, "ChefConfiguration": { "shape": "ChefConfiguration", "documentation": "A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
Whether to use custom cookbooks.
" }, "UseOpsworksSecurityGroups": { "shape": "Boolean", "documentation": "Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
OpsWorks Stacks provides a standard set of security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
True - OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.
False - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
" }, "CustomCookbooksSource": { "shape": "Source", "documentation": "Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
" }, "DefaultSshKeyName": { "shape": "String", "documentation": "A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
" }, "ClonePermissions": { "shape": "Boolean", "documentation": "Whether to clone the source stack's permissions.
" }, "CloneAppIds": { "shape": "Strings", "documentation": "A list of source stack app IDs to be included in the cloned stack.
" }, "DefaultRootDeviceType": { "shape": "RootDeviceType", "documentation": "The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
" }, "AgentVersion": { "shape": "String", "documentation": "The default OpsWorks Stacks agent version. You have the following options:
Auto-update - Set this parameter to LATEST. OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. OpsWorks Stacks automatically installs that version on the stack's instances.
The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
The cloned stack ID.
" } }, "documentation": "Contains the response to a CloneStack request.
Whether CloudWatch Logs is enabled for a layer.
" }, "LogStreams": { "shape": "CloudWatchLogsLogStreams", "documentation": "A list of configuration options for CloudWatch Logs.
" } }, "documentation": "Describes the Amazon CloudWatch Logs configuration for a layer.
" }, "CloudWatchLogsEncoding": { "type": "string", "documentation": "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.
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.
", "enum": [ "start_of_file", "end_of_file" ] }, "CloudWatchLogsLogStream": { "type": "structure", "members": { "LogGroupName": { "shape": "String", "documentation": "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).
" }, "DatetimeFormat": { "shape": "String", "documentation": "Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
" }, "TimeZone": { "shape": "CloudWatchLogsTimeZone", "documentation": "Specifies the time zone of log event time stamps.
" }, "File": { "shape": "String", "documentation": "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.
" }, "FileFingerprintLines": { "shape": "String", "documentation": "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.
" }, "MultiLineStartPattern": { "shape": "String", "documentation": "Specifies the pattern for identifying the start of a log message.
" }, "InitialPosition": { "shape": "CloudWatchLogsInitialPosition", "documentation": "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.
" }, "Encoding": { "shape": "CloudWatchLogsEncoding", "documentation": "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.
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
" }, "BatchCount": { "shape": "Integer", "documentation": "Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
" }, "BatchSize": { "shape": "Integer", "documentation": "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.
" } }, "documentation": "Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.
" }, "CloudWatchLogsLogStreams": { "type": "list", "member": { "shape": "CloudWatchLogsLogStream" }, "documentation": "Describes the Amazon CloudWatch Logs configuration for a layer.
" }, "CloudWatchLogsTimeZone": { "type": "string", "documentation": "The preferred time zone for logs streamed to CloudWatch Logs. Valid values are LOCAL and UTC, for Coordinated Universal Time.
The command ID.
" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance where the command was executed.
" }, "DeploymentId": { "shape": "String", "documentation": "The command deployment ID.
" }, "CreatedAt": { "shape": "DateTime", "documentation": "Date and time when the command was run.
" }, "AcknowledgedAt": { "shape": "DateTime", "documentation": "Date and time when the command was acknowledged.
" }, "CompletedAt": { "shape": "DateTime", "documentation": "Date when the command completed.
" }, "Status": { "shape": "String", "documentation": "The command status:
failed
successful
skipped
pending
The command exit code.
" }, "LogUrl": { "shape": "String", "documentation": "The URL of the command log.
" }, "Type": { "shape": "String", "documentation": "The command type:
configure
deploy
execute_recipes
install_dependencies
restart
rollback
setup
start
stop
undeploy
update_custom_cookbooks
update_dependencies
Describes a command.
" }, "Commands": { "type": "list", "member": { "shape": "Command" } }, "CreateAppRequest": { "type": "structure", "required": [ "StackId", "Name", "Type" ], "members": { "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "Shortname": { "shape": "String", "documentation": "The app's short name.
" }, "Name": { "shape": "String", "documentation": "The app name.
" }, "Description": { "shape": "String", "documentation": "A description of the app.
" }, "DataSources": { "shape": "DataSources", "documentation": "The app's data source.
" }, "Type": { "shape": "AppType", "documentation": "The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other.
A Source object that specifies the app repository.
The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
Whether to enable SSL for the app.
" }, "SslConfiguration": { "shape": "SslConfiguration", "documentation": "An SslConfiguration object with the SSL configuration.
One or more user-defined key/value pairs to be added to the stack attributes.
" }, "Environment": { "shape": "EnvironmentVariables", "documentation": "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 instance. 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 variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20KB).\"
If you have specified one or more environment variables, you cannot modify the stack's Chef version.
The app ID.
" } }, "documentation": "Contains the response to a CreateApp request.
The stack ID.
" }, "AppId": { "shape": "String", "documentation": "The app ID. This parameter is required for app deployments, but not for other deployment commands.
" }, "InstanceIds": { "shape": "Strings", "documentation": "The instance IDs for the deployment targets.
" }, "LayerIds": { "shape": "Strings", "documentation": "The layer IDs for the deployment targets.
" }, "Command": { "shape": "DeploymentCommand", "documentation": "A DeploymentCommand object that specifies the deployment command and any associated arguments.
A user-defined comment.
" }, "CustomJson": { "shape": "String", "documentation": "A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.
" } } }, "CreateDeploymentResult": { "type": "structure", "members": { "DeploymentId": { "shape": "String", "documentation": "The deployment ID, which can be used with other requests to identify the deployment.
" } }, "documentation": "Contains the response to a CreateDeployment request.
The stack ID.
" }, "LayerIds": { "shape": "Strings", "documentation": "An array that contains the instance's layer IDs.
" }, "InstanceType": { "shape": "String", "documentation": "The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
" }, "Hostname": { "shape": "String", "documentation": "The instance host name. The following are character limits for instance host names.
Linux-based instances: 63 characters
Windows-based instances: 15 characters
The instance's operating system, which must be set to one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom.
Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about how to use custom AMIs with OpsWorks Stacks, see Using Custom AMIs.
A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.
If you specify a custom AMI, you must set Os to Custom.
The instance's Amazon EC2 key-pair name.
" }, "AvailabilityZone": { "shape": "String", "documentation": "The instance Availability Zone. For more information, see Regions and Endpoints.
" }, "VirtualizationType": { "shape": "String", "documentation": "The instance's virtualization type, paravirtual or hvm.
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.
" }, "Architecture": { "shape": "Architecture", "documentation": "The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
The instance root device type. For more information, see Storage for the Root Device.
" }, "BlockDeviceMappings": { "shape": "BlockDeviceMappings", "documentation": "An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to 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.
Whether to create an Amazon EBS-optimized instance.
" }, "AgentVersion": { "shape": "String", "documentation": "The default OpsWorks Stacks agent version. You have the following options:
INHERIT - Use the stack's default agent version setting.
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance.
The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.
The instance ID.
" } }, "documentation": "Contains the response to a CreateInstance request.
The layer stack ID.
" }, "Type": { "shape": "LayerType", "documentation": "The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.
" }, "Name": { "shape": "String", "documentation": "The layer name, which is used by the console. Layer names can be a maximum of 32 characters.
" }, "Shortname": { "shape": "String", "documentation": "For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
Built-in layer short names are defined by OpsWorks Stacks. For more information, see the Layer Reference.
" }, "Attributes": { "shape": "LayerAttributes", "documentation": "One or more user-defined key-value pairs to be added to the stack attributes.
To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
" }, "CustomInstanceProfileArn": { "shape": "String", "documentation": "The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
" }, "CustomJson": { "shape": "String", "documentation": "A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the CLI.
" }, "CustomSecurityGroupIds": { "shape": "Strings", "documentation": "An array containing the layer custom security group IDs.
" }, "Packages": { "shape": "Strings", "documentation": "An array of Package objects that describes the layer packages.
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Whether to disable auto healing for the layer.
" }, "AutoAssignElasticIps": { "shape": "Boolean", "documentation": "Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
" }, "AutoAssignPublicIps": { "shape": "Boolean", "documentation": "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.
" }, "CustomRecipes": { "shape": "Recipes", "documentation": "A LayerCustomRecipes object that specifies the layer custom recipes.
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
To ensure that your instances have the latest security updates, we strongly recommend using the default value of true.
Whether to use Amazon EBS-optimized instances.
" }, "LifecycleEventConfiguration": { "shape": "LifecycleEventConfiguration", "documentation": "A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
The layer ID.
" } }, "documentation": "Contains the response to a CreateLayer request.
The stack name. Stack names can be a maximum of 64 characters.
" }, "Region": { "shape": "String", "documentation": "The stack's Amazon Web Services Region, such as ap-south-1. For more information about Amazon Web Services Regions, see Regions and Endpoints.
In the CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the CLI common parameter --region are set to the same value, the stack uses a regional endpoint. If the --stack-region parameter is not set, but the CLI --region parameter is, this also results in a stack with a regional endpoint. However, if the --region parameter is set to us-east-1, and the --stack-region parameter is set to one of the following, then the stack uses a legacy or classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2. In this case, the actual API endpoint of the stack is in us-east-1. Only the preceding regions are supported as classic regions in the us-east-1 API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region.
The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.
If your account supports EC2-Classic, the default value is no VPC.
If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
It must belong to a VPC in your account that is in the specified region.
You must specify a value for DefaultSubnetId.
For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.
" }, "Attributes": { "shape": "StackAttributes", "documentation": "One or more user-defined key-value pairs to be added to the stack attributes.
" }, "ServiceRoleArn": { "shape": "String", "documentation": "The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
" }, "DefaultInstanceProfileArn": { "shape": "String", "documentation": "The Amazon Resource Name (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.
" }, "DefaultOs": { "shape": "String", "documentation": "The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
The default option is the current Amazon Linux version. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.
" }, "HostnameTheme": { "shape": "String", "documentation": "The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
A string that contains user-defined, custom JSON. It can be used 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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
" }, "ConfigurationManager": { "shape": "StackConfigurationManager", "documentation": "The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
" }, "ChefConfiguration": { "shape": "ChefConfiguration", "documentation": "A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
Whether the stack uses custom cookbooks.
" }, "UseOpsworksSecurityGroups": { "shape": "Boolean", "documentation": "Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
True - OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
False - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
" }, "CustomCookbooksSource": { "shape": "Source", "documentation": "Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
" }, "DefaultSshKeyName": { "shape": "String", "documentation": "A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
" }, "DefaultRootDeviceType": { "shape": "RootDeviceType", "documentation": "The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.
The default OpsWorks Stacks agent version. You have the following options:
Auto-update - Set this parameter to LATEST. OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. OpsWorks Stacks installs that version on the stack's instances.
The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.
Contains the response to a CreateStack request.
The user's IAM ARN; this can also be a federated user's ARN.
" }, "SshUsername": { "shape": "String", "documentation": "The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example, my.name is changed to myname. If you do not specify an SSH user name, OpsWorks Stacks generates one from the IAM user name.
The user's public SSH key.
" }, "AllowSelfManagement": { "shape": "Boolean", "documentation": "Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.
" } } }, "CreateUserProfileResult": { "type": "structure", "members": { "IamUserArn": { "shape": "String", "documentation": "The user's IAM ARN.
" } }, "documentation": "Contains the response to a CreateUserProfile request.
The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, RdsDbInstance, or None.
The data source's ARN.
" }, "DatabaseName": { "shape": "String", "documentation": "The database name.
" } }, "documentation": "Describes an app's data source.
" }, "DataSources": { "type": "list", "member": { "shape": "DataSource" } }, "DateTime": { "type": "string" }, "DeleteAppRequest": { "type": "structure", "required": [ "AppId" ], "members": { "AppId": { "shape": "String", "documentation": "The app ID.
" } } }, "DeleteInstanceRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" }, "DeleteElasticIp": { "shape": "Boolean", "documentation": "Whether to delete the instance Elastic IP address.
" }, "DeleteVolumes": { "shape": "Boolean", "documentation": "Whether to delete the instance's Amazon EBS volumes.
" } } }, "DeleteLayerRequest": { "type": "structure", "required": [ "LayerId" ], "members": { "LayerId": { "shape": "String", "documentation": "The layer ID.
" } } }, "DeleteStackRequest": { "type": "structure", "required": [ "StackId" ], "members": { "StackId": { "shape": "String", "documentation": "The stack ID.
" } } }, "DeleteUserProfileRequest": { "type": "structure", "required": [ "IamUserArn" ], "members": { "IamUserArn": { "shape": "String", "documentation": "The user's IAM ARN. This can also be a federated user's ARN.
" } } }, "Deployment": { "type": "structure", "members": { "DeploymentId": { "shape": "String", "documentation": "The deployment ID.
" }, "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "AppId": { "shape": "String", "documentation": "The app ID.
" }, "CreatedAt": { "shape": "DateTime", "documentation": "Date when the deployment was created.
" }, "CompletedAt": { "shape": "DateTime", "documentation": "Date when the deployment completed.
" }, "Duration": { "shape": "Integer", "documentation": "The deployment duration.
" }, "IamUserArn": { "shape": "String", "documentation": "The user's IAM ARN.
" }, "Comment": { "shape": "String", "documentation": "A user-defined comment.
" }, "Command": { "shape": "DeploymentCommand", "documentation": "Used to specify a stack or deployment command.
" }, "Status": { "shape": "String", "documentation": "The deployment status:
running
successful
failed
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.
" }, "InstanceIds": { "shape": "Strings", "documentation": "The IDs of the target instances.
" } }, "documentation": "Describes a deployment of a stack or app.
" }, "DeploymentCommand": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "DeploymentCommandName", "documentation": "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.
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\"] }
Used to specify a stack or deployment command.
" }, "DeploymentCommandArgs": { "type": "map", "key": { "shape": "String" }, "value": { "shape": "Strings" } }, "DeploymentCommandName": { "type": "string", "enum": [ "install_dependencies", "update_dependencies", "update_custom_cookbooks", "execute_recipes", "configure", "setup", "deploy", "rollback", "start", "stop", "restart", "undeploy" ] }, "Deployments": { "type": "list", "member": { "shape": "Deployment" } }, "DeregisterEcsClusterRequest": { "type": "structure", "required": [ "EcsClusterArn" ], "members": { "EcsClusterArn": { "shape": "String", "documentation": "The cluster's Amazon Resource Number (ARN).
" } } }, "DeregisterElasticIpRequest": { "type": "structure", "required": [ "ElasticIp" ], "members": { "ElasticIp": { "shape": "String", "documentation": "The Elastic IP address.
" } } }, "DeregisterInstanceRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" } } }, "DeregisterRdsDbInstanceRequest": { "type": "structure", "required": [ "RdsDbInstanceArn" ], "members": { "RdsDbInstanceArn": { "shape": "String", "documentation": "The Amazon RDS instance's ARN.
" } } }, "DeregisterVolumeRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "VolumeId": { "shape": "String", "documentation": "The OpsWorks Stacks volume ID, which is the GUID that OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.
" } } }, "DescribeAgentVersionsRequest": { "type": "structure", "members": { "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "ConfigurationManager": { "shape": "StackConfigurationManager", "documentation": "The configuration manager.
" } } }, "DescribeAgentVersionsResult": { "type": "structure", "members": { "AgentVersions": { "shape": "AgentVersions", "documentation": "The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.
" } }, "documentation": "Contains the response to a DescribeAgentVersions request.
The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.
An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.
An array of App objects that describe the specified apps.
Contains the response to a DescribeApps request.
The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.
The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.
An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.
An array of Command objects that describe each of the specified commands.
Contains the response to a DescribeCommands request.
The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.
" }, "AppId": { "shape": "String", "documentation": "The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.
" }, "DeploymentIds": { "shape": "Strings", "documentation": "An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.
" } } }, "DescribeDeploymentsResult": { "type": "structure", "members": { "Deployments": { "shape": "Deployments", "documentation": "An array of Deployment objects that describe the deployments.
Contains the response to a DescribeDeployments request.
A list of ARNs, one for each cluster to be described.
" }, "StackId": { "shape": "String", "documentation": "A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.
If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
A list of EcsCluster objects containing the cluster descriptions.
If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.
Contains the response to a DescribeEcsClusters request.
The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.
A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.
An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.
An ElasticIps object that describes the specified Elastic IP addresses.
Contains the response to a DescribeElasticIps request.
A stack ID. The action describes the stack's Elastic Load Balancing instances.
" }, "LayerIds": { "shape": "Strings", "documentation": "A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.
" } } }, "DescribeElasticLoadBalancersResult": { "type": "structure", "members": { "ElasticLoadBalancers": { "shape": "ElasticLoadBalancers", "documentation": "A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.
Contains the response to a DescribeElasticLoadBalancers request.
A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.
A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.
An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.
An array of Instance objects that describe the instances.
Contains the response to a DescribeInstances request.
The stack ID.
" }, "LayerIds": { "shape": "Strings", "documentation": "An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.
An array of Layer objects that describe the layers.
Contains the response to a DescribeLayers request.
An array of layer IDs.
" } } }, "DescribeLoadBasedAutoScalingResult": { "type": "structure", "members": { "LoadBasedAutoScalingConfigurations": { "shape": "LoadBasedAutoScalingConfigurations", "documentation": "An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.
Contains the response to a DescribeLoadBasedAutoScaling request.
A UserProfile object that describes the user's SSH information.
Contains the response to a DescribeMyUserProfile request.
Contains information in response to a DescribeOperatingSystems request.
The response to a DescribeOperatingSystems request.
The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers.
" }, "StackId": { "shape": "String", "documentation": "The stack ID.
" } } }, "DescribePermissionsResult": { "type": "structure", "members": { "Permissions": { "shape": "Permissions", "documentation": "An array of Permission objects that describe the stack permissions.
If the request object contains only a stack ID, the array contains a Permission object with permissions for each of the stack IAM ARNs.
If the request object contains only an IAM ARN, the array contains a Permission object with permissions for each of the user's stack IDs.
If the request contains a stack ID and an IAM ARN, the array contains a single Permission object with permissions for the specified stack and IAM ARN.
Contains the response to a DescribePermissions request.
The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.
The stack ID.
" }, "RaidArrayIds": { "shape": "Strings", "documentation": "An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.
A RaidArrays object that describes the specified RAID arrays.
Contains the response to a DescribeRaidArrays request.
The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.
" }, "RdsDbInstanceArns": { "shape": "Strings", "documentation": "An array containing the ARNs of the instances to be described.
" } } }, "DescribeRdsDbInstancesResult": { "type": "structure", "members": { "RdsDbInstances": { "shape": "RdsDbInstances", "documentation": "An a array of RdsDbInstance objects that describe the instances.
Contains the response to a DescribeRdsDbInstances request.
The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.
The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.
An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.
An array of ServiceError objects that describe the specified service errors.
Contains the response to a DescribeServiceErrors request.
The stack ID.
" } } }, "DescribeStackProvisioningParametersResult": { "type": "structure", "members": { "AgentInstallerUrl": { "shape": "String", "documentation": "The OpsWorks Stacks agent installer's URL.
" }, "Parameters": { "shape": "Parameters", "documentation": "An embedded object that contains the provisioning parameters.
" } }, "documentation": "Contains the response to a DescribeStackProvisioningParameters request.
The stack ID.
" } } }, "DescribeStackSummaryResult": { "type": "structure", "members": { "StackSummary": { "shape": "StackSummary", "documentation": "A StackSummary object that contains the results.
Contains the response to a DescribeStackSummary request.
An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information about all stacks, DescribeStacks returns a description of every stack. If the IAM policy that is attached to an IAM user limits the DescribeStacks action to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. Otherwise, DescribeStacks returns an AccessDenied error.
An array of Stack objects that describe the stacks.
Contains the response to a DescribeStacks request.
An array of instance IDs.
" } } }, "DescribeTimeBasedAutoScalingResult": { "type": "structure", "members": { "TimeBasedAutoScalingConfigurations": { "shape": "TimeBasedAutoScalingConfigurations", "documentation": "An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.
Contains the response to a DescribeTimeBasedAutoScaling request.
An array of IAM or federated user ARNs that identify the users to be described.
" } } }, "DescribeUserProfilesResult": { "type": "structure", "members": { "UserProfiles": { "shape": "UserProfiles", "documentation": "A Users object that describes the specified users.
Contains the response to a DescribeUserProfiles request.
The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.
A stack ID. The action describes the stack's registered Amazon EBS volumes.
" }, "RaidArrayId": { "shape": "String", "documentation": "The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.
Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.
An array of volume IDs.
" } }, "documentation": "Contains the response to a DescribeVolumes request.
The Elastic Load Balancing instance's name.
" }, "LayerId": { "shape": "String", "documentation": "The ID of the layer that the Elastic Load Balancing instance is attached to.
" } } }, "DisassociateElasticIpRequest": { "type": "structure", "required": [ "ElasticIp" ], "members": { "ElasticIp": { "shape": "String", "documentation": "The Elastic IP address.
" } } }, "Double": { "type": "double", "box": true }, "EbsBlockDevice": { "type": "structure", "members": { "SnapshotId": { "shape": "String", "documentation": "The snapshot ID.
" }, "Iops": { "shape": "Integer", "documentation": "The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.
" }, "VolumeSize": { "shape": "Integer", "documentation": "The volume size, in GiB. For more information, see EbsBlockDevice.
" }, "VolumeType": { "shape": "VolumeType", "documentation": "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).
Whether the volume is deleted on instance termination.
" } }, "documentation": "Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.
" }, "EcsCluster": { "type": "structure", "members": { "EcsClusterArn": { "shape": "String", "documentation": "The cluster's ARN.
" }, "EcsClusterName": { "shape": "String", "documentation": "The cluster name.
" }, "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "RegisteredAt": { "shape": "DateTime", "documentation": "The time and date that the cluster was registered with the stack.
" } }, "documentation": "Describes a registered Amazon ECS cluster.
" }, "EcsClusters": { "type": "list", "member": { "shape": "EcsCluster" } }, "ElasticIp": { "type": "structure", "members": { "Ip": { "shape": "String", "documentation": "The IP address.
" }, "Name": { "shape": "String", "documentation": "The name, which can be a maximum of 32 characters.
" }, "Domain": { "shape": "String", "documentation": "The domain.
" }, "Region": { "shape": "String", "documentation": "The Amazon Web Services Region. For more information, see Regions and Endpoints.
" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance that the address is attached to.
" } }, "documentation": "Describes an Elastic IP address.
" }, "ElasticIps": { "type": "list", "member": { "shape": "ElasticIp" } }, "ElasticLoadBalancer": { "type": "structure", "members": { "ElasticLoadBalancerName": { "shape": "String", "documentation": "The Elastic Load Balancing instance name.
" }, "Region": { "shape": "String", "documentation": "The instance's Amazon Web Services Region.
" }, "DnsName": { "shape": "String", "documentation": "The instance's public DNS name.
" }, "StackId": { "shape": "String", "documentation": "The ID of the stack with which the instance is associated.
" }, "LayerId": { "shape": "String", "documentation": "The ID of the layer to which the instance is attached.
" }, "VpcId": { "shape": "String", "documentation": "The VPC ID.
" }, "AvailabilityZones": { "shape": "Strings", "documentation": "A list of Availability Zones.
" }, "SubnetIds": { "shape": "Strings", "documentation": "A list of subnet IDs, if the stack is running in a VPC.
" }, "Ec2InstanceIds": { "shape": "Strings", "documentation": "A list of the EC2 instances for which the Elastic Load Balancing instance is managing traffic.
" } }, "documentation": "Describes an Elastic Load Balancing instance.
" }, "ElasticLoadBalancers": { "type": "list", "member": { "shape": "ElasticLoadBalancer" } }, "EnvironmentVariable": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "String", "documentation": "(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.
" }, "Value": { "shape": "String", "documentation": "(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.
" }, "Secure": { "shape": "Boolean", "documentation": "(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.
Represents an app's environment variable.
" }, "EnvironmentVariables": { "type": "list", "member": { "shape": "EnvironmentVariable" } }, "GetHostnameSuggestionRequest": { "type": "structure", "required": [ "LayerId" ], "members": { "LayerId": { "shape": "String", "documentation": "The layer ID.
" } } }, "GetHostnameSuggestionResult": { "type": "structure", "members": { "LayerId": { "shape": "String", "documentation": "The layer ID.
" }, "Hostname": { "shape": "String", "documentation": "The generated host name.
" } }, "documentation": "Contains the response to a GetHostnameSuggestion request.
The instance's OpsWorks Stacks ID.
" }, "ValidForInMinutes": { "shape": "ValidForInMinutes", "documentation": "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 the user is logged in at the time, they are logged out.
" } } }, "GrantAccessResult": { "type": "structure", "members": { "TemporaryCredential": { "shape": "TemporaryCredential", "documentation": "A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection.
Contains the response to a GrantAccess request.
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.
A custom AMI ID to be used to create the instance. For more information, see Instances
" }, "Architecture": { "shape": "Architecture", "documentation": "The instance architecture: \"i386\" or \"x86_64\".
" }, "Arn": { "shape": "String", "documentation": "The instance's Amazon Resource Number (ARN).
" }, "AutoScalingType": { "shape": "AutoScalingType", "documentation": "For load-based or time-based instances, the type.
" }, "AvailabilityZone": { "shape": "String", "documentation": "The instance Availability Zone. For more information, see Regions and Endpoints.
" }, "BlockDeviceMappings": { "shape": "BlockDeviceMappings", "documentation": "An array of BlockDeviceMapping objects that specify the instance's block device mappings.
The time that the instance was created.
" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Whether this is an Amazon EBS-optimized instance.
" }, "Ec2InstanceId": { "shape": "String", "documentation": "The ID of the associated Amazon EC2 instance.
" }, "EcsClusterArn": { "shape": "String", "documentation": "For container instances, the Amazon ECS cluster's ARN.
" }, "EcsContainerInstanceArn": { "shape": "String", "documentation": "For container instances, the instance's ARN.
" }, "ElasticIp": { "shape": "String", "documentation": "The instance Elastic IP address.
" }, "Hostname": { "shape": "String", "documentation": "The instance host name. The following are character limits for instance host names.
Linux-based instances: 63 characters
Windows-based instances: 15 characters
For registered instances, the infrastructure class: ec2 or on-premises.
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 CreateDeployment to 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.
The instance ID.
" }, "InstanceProfileArn": { "shape": "String", "documentation": "The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
" }, "InstanceType": { "shape": "String", "documentation": "The instance type, such as t2.micro.
The ID of the last service error. For more information, call DescribeServiceErrors.
" }, "LayerIds": { "shape": "Strings", "documentation": "An array containing the instance layer IDs.
" }, "Os": { "shape": "String", "documentation": "The instance's operating system.
" }, "Platform": { "shape": "String", "documentation": "The instance's platform.
" }, "PrivateDns": { "shape": "String", "documentation": "The instance's private DNS name.
" }, "PrivateIp": { "shape": "String", "documentation": "The instance's private IP address.
" }, "PublicDns": { "shape": "String", "documentation": "The instance public DNS name.
" }, "PublicIp": { "shape": "String", "documentation": "The instance public IP address.
" }, "RegisteredBy": { "shape": "String", "documentation": "For registered instances, who performed the registration.
" }, "ReportedAgentVersion": { "shape": "String", "documentation": "The instance's reported OpsWorks Stacks agent version.
" }, "ReportedOs": { "shape": "ReportedOs", "documentation": "For registered instances, the reported operating system.
" }, "RootDeviceType": { "shape": "RootDeviceType", "documentation": "The instance's root device type. For more information, see Storage for the Root Device.
" }, "RootDeviceVolumeId": { "shape": "String", "documentation": "The root device volume ID.
" }, "SecurityGroupIds": { "shape": "Strings", "documentation": "An array containing the instance security group IDs.
" }, "SshHostDsaKeyFingerprint": { "shape": "String", "documentation": "The SSH key's Deep Security Agent (DSA) fingerprint.
" }, "SshHostRsaKeyFingerprint": { "shape": "String", "documentation": "The SSH key's RSA fingerprint.
" }, "SshKeyName": { "shape": "String", "documentation": "The instance's Amazon EC2 key-pair name.
" }, "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "Status": { "shape": "String", "documentation": "The instance status:
booting
connection_lost
online
pending
rebooting
requested
running_setup
setup_failed
shutting_down
start_failed
stop_failed
stopped
stopping
terminated
terminating
The instance's subnet ID; applicable only if the stack is running in a VPC.
" }, "Tenancy": { "shape": "String", "documentation": "The instance's tenancy option, such as dedicated or host.
The instance's virtualization type: paravirtual or hvm.
Describes an instance.
" }, "InstanceIdentity": { "type": "structure", "members": { "Document": { "shape": "String", "documentation": "A JSON document that contains the metadata.
" }, "Signature": { "shape": "String", "documentation": "A signature that can be used to verify the document's accuracy and authenticity.
" } }, "documentation": "Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.
" }, "Instances": { "type": "list", "member": { "shape": "Instance" } }, "InstancesCount": { "type": "structure", "members": { "Assigning": { "shape": "Integer", "documentation": "The number of instances in the Assigning state.
" }, "Booting": { "shape": "Integer", "documentation": "The number of instances with booting status.
The number of instances with connection_lost status.
The number of instances in the Deregistering state.
" }, "Online": { "shape": "Integer", "documentation": "The number of instances with online status.
The number of instances with pending status.
The number of instances with rebooting status.
The number of instances in the Registered state.
" }, "Registering": { "shape": "Integer", "documentation": "The number of instances in the Registering state.
" }, "Requested": { "shape": "Integer", "documentation": "The number of instances with requested status.
The number of instances with running_setup status.
The number of instances with setup_failed status.
The number of instances with shutting_down status.
The number of instances with start_failed status.
The number of instances with stop_failed status.
The number of instances with stopped status.
The number of instances with stopping status.
The number of instances with terminated status.
The number of instances with terminating status.
The number of instances in the Unassigning state.
" } }, "documentation": "Describes how many instances a stack has for each status.
" }, "Integer": { "type": "integer", "box": true }, "Layer": { "type": "structure", "members": { "Arn": { "shape": "String", "documentation": "The Amazon Resource Number (ARN) of a layer.
" }, "StackId": { "shape": "String", "documentation": "The layer stack ID.
" }, "LayerId": { "shape": "String", "documentation": "The layer ID.
" }, "Type": { "shape": "LayerType", "documentation": "The layer type.
" }, "Name": { "shape": "String", "documentation": "The layer name. Layer names can be a maximum of 32 characters.
" }, "Shortname": { "shape": "String", "documentation": "The layer short name.
" }, "Attributes": { "shape": "LayerAttributes", "documentation": "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.
The Amazon CloudWatch Logs configuration settings for the layer.
" }, "CustomInstanceProfileArn": { "shape": "String", "documentation": "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.
" }, "CustomJson": { "shape": "String", "documentation": "A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
" }, "CustomSecurityGroupIds": { "shape": "Strings", "documentation": "An array containing the layer's custom security group IDs.
" }, "DefaultSecurityGroupNames": { "shape": "Strings", "documentation": "An array containing the layer's security group names.
" }, "Packages": { "shape": "Strings", "documentation": "An array of Package objects that describe the layer's packages.
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Whether auto healing is disabled for the layer.
" }, "AutoAssignElasticIps": { "shape": "Boolean", "documentation": "Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
" }, "AutoAssignPublicIps": { "shape": "Boolean", "documentation": "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.
" }, "DefaultRecipes": { "shape": "Recipes", "documentation": "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.
A LayerCustomRecipes object that specifies the layer's custom recipes.
Date when the layer was created.
" }, "InstallUpdatesOnBoot": { "shape": "Boolean", "documentation": "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 CreateDeployment to 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.
Whether the layer uses Amazon EBS-optimized instances.
" }, "LifecycleEventConfiguration": { "shape": "LifecycleEventConfiguration", "documentation": "A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
Describes a layer.
" }, "LayerAttributes": { "type": "map", "key": { "shape": "LayerAttributesKeys" }, "value": { "shape": "String" } }, "LayerAttributesKeys": { "type": "string", "enum": [ "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": { "type": "string", "enum": [ "aws-flow-ruby", "ecs-cluster", "java-app", "lb", "web", "php-app", "rails-app", "nodejs-app", "memcached", "db-master", "monitoring-master", "custom" ] }, "Layers": { "type": "list", "member": { "shape": "Layer" } }, "LifecycleEventConfiguration": { "type": "structure", "members": { "Shutdown": { "shape": "ShutdownEventConfiguration", "documentation": "A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
Specifies the lifecycle event configuration
" }, "ListTagsRequest": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "The stack or layer's Amazon Resource Number (ARN).
" }, "MaxResults": { "shape": "MaxResults", "documentation": "Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest call.
Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call.
A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.
" }, "NextToken": { "shape": "NextToken", "documentation": "If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to get the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.
Contains the response to a ListTags request.
The layer ID.
" }, "Enable": { "shape": "Boolean", "documentation": "Whether load-based auto scaling is enabled for the layer.
" }, "UpScaling": { "shape": "AutoScalingThresholds", "documentation": "An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when OpsWorks Stacks increases the number of instances.
An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when OpsWorks Stacks reduces the number of instances.
Describes a layer's load-based auto scaling configuration.
" }, "LoadBasedAutoScalingConfigurations": { "type": "list", "member": { "shape": "LoadBasedAutoScalingConfiguration" } }, "MaxResults": { "type": "integer" }, "Minute": { "type": "integer", "box": true, "max": 100, "min": 1 }, "NextToken": { "type": "string" }, "OperatingSystem": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of the operating system, such as Amazon Linux 2.
The ID of a supported operating system, such as Amazon Linux 2.
The type of a supported operating system, either Linux or Windows.
Supported configuration manager name and versions for an OpsWorks Stacks operating system.
" }, "ReportedName": { "shape": "String", "documentation": "A short name for the operating system manufacturer.
" }, "ReportedVersion": { "shape": "String", "documentation": "The version of the operating system, including the release and edition, if applicable.
" }, "Supported": { "shape": "Boolean", "documentation": "Indicates that an operating system is not supported for new instances.
" } }, "documentation": "Describes supported operating systems in OpsWorks Stacks.
" }, "OperatingSystemConfigurationManager": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of the configuration manager, which is Chef.
" }, "Version": { "shape": "String", "documentation": "The versions of the configuration manager that are supported by an operating system.
" } }, "documentation": "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": { "type": "list", "member": { "shape": "OperatingSystemConfigurationManager" } }, "OperatingSystems": { "type": "list", "member": { "shape": "OperatingSystem" } }, "Parameters": { "type": "map", "key": { "shape": "String" }, "value": { "shape": "String" } }, "Permission": { "type": "structure", "members": { "StackId": { "shape": "String", "documentation": "A stack ID.
" }, "IamUserArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) for an Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.
" }, "AllowSsh": { "shape": "Boolean", "documentation": "Whether the user can use SSH.
" }, "AllowSudo": { "shape": "Boolean", "documentation": "Whether the user can use sudo.
" }, "Level": { "shape": "String", "documentation": "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
" } }, "documentation": "Describes stack or user permissions.
" }, "Permissions": { "type": "list", "member": { "shape": "Permission" } }, "RaidArray": { "type": "structure", "members": { "RaidArrayId": { "shape": "String", "documentation": "The array ID.
" }, "InstanceId": { "shape": "String", "documentation": "The instance ID.
" }, "Name": { "shape": "String", "documentation": "The array name.
" }, "RaidLevel": { "shape": "Integer", "documentation": "The RAID level.
" }, "NumberOfDisks": { "shape": "Integer", "documentation": "The number of disks in the array.
" }, "Size": { "shape": "Integer", "documentation": "The array's size.
" }, "Device": { "shape": "String", "documentation": "The array's Linux device. For example /dev/mdadm0.
" }, "MountPoint": { "shape": "String", "documentation": "The array's mount point.
" }, "AvailabilityZone": { "shape": "String", "documentation": "The array's Availability Zone. For more information, see Regions and Endpoints.
" }, "CreatedAt": { "shape": "DateTime", "documentation": "When the RAID array was created.
" }, "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "VolumeType": { "shape": "String", "documentation": "The volume type, standard or PIOPS.
" }, "Iops": { "shape": "Integer", "documentation": "For PIOPS volumes, the IOPS per disk.
" } }, "documentation": "Describes an instance's RAID array.
" }, "RaidArrays": { "type": "list", "member": { "shape": "RaidArray" } }, "RdsDbInstance": { "type": "structure", "members": { "RdsDbInstanceArn": { "shape": "String", "documentation": "The instance's ARN.
" }, "DbInstanceIdentifier": { "shape": "String", "documentation": "The database instance identifier.
" }, "DbUser": { "shape": "String", "documentation": "The master user name.
" }, "DbPassword": { "shape": "String", "documentation": "OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
The instance's Amazon Web Services Region.
" }, "Address": { "shape": "String", "documentation": "The instance's address.
" }, "Engine": { "shape": "String", "documentation": "The instance's database engine.
" }, "StackId": { "shape": "String", "documentation": "The ID of the stack with which the instance is registered.
" }, "MissingOnRds": { "shape": "Boolean", "documentation": "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.
Describes an Amazon RDS instance.
" }, "RdsDbInstances": { "type": "list", "member": { "shape": "RdsDbInstance" } }, "RebootInstanceRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" } } }, "Recipes": { "type": "structure", "members": { "Setup": { "shape": "Strings", "documentation": "An array of custom recipe names to be run following a setup event.
An array of custom recipe names to be run following a configure event.
An array of custom recipe names to be run following a deploy event.
An array of custom recipe names to be run following a undeploy event.
An array of custom recipe names to be run following a shutdown event.
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.
" }, "RegisterEcsClusterRequest": { "type": "structure", "required": [ "EcsClusterArn", "StackId" ], "members": { "EcsClusterArn": { "shape": "String", "documentation": "The cluster's ARN.
" }, "StackId": { "shape": "String", "documentation": "The stack ID.
" } } }, "RegisterEcsClusterResult": { "type": "structure", "members": { "EcsClusterArn": { "shape": "String", "documentation": "The cluster's ARN.
" } }, "documentation": "Contains the response to a RegisterEcsCluster request.
The Elastic IP address.
" }, "StackId": { "shape": "String", "documentation": "The stack ID.
" } } }, "RegisterElasticIpResult": { "type": "structure", "members": { "ElasticIp": { "shape": "String", "documentation": "The Elastic IP address.
" } }, "documentation": "Contains the response to a RegisterElasticIp request.
The ID of the stack that the instance is to be registered with.
" }, "Hostname": { "shape": "String", "documentation": "The instance's host name. The following are character limits for instance host names.
Linux-based instances: 63 characters
Windows-based instances: 15 characters
The instance's public IP address.
" }, "PrivateIp": { "shape": "String", "documentation": "The instance's private IP address.
" }, "RsaPublicKey": { "shape": "String", "documentation": "The instances public RSA key. This key is used to encrypt communication between the instance and the service.
" }, "RsaPublicKeyFingerprint": { "shape": "String", "documentation": "The instances public RSA key fingerprint.
" }, "InstanceIdentity": { "shape": "InstanceIdentity", "documentation": "An InstanceIdentity object that contains the instance's identity.
" } } }, "RegisterInstanceResult": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The registered instance's OpsWorks Stacks ID.
" } }, "documentation": "Contains the response to a RegisterInstanceResult request.
The stack ID.
" }, "RdsDbInstanceArn": { "shape": "String", "documentation": "The Amazon RDS instance's ARN.
" }, "DbUser": { "shape": "String", "documentation": "The database's master user name.
" }, "DbPassword": { "shape": "String", "documentation": "The database password.
" } } }, "RegisterVolumeRequest": { "type": "structure", "required": [ "StackId" ], "members": { "Ec2VolumeId": { "shape": "String", "documentation": "The Amazon EBS volume ID.
" }, "StackId": { "shape": "String", "documentation": "The stack ID.
" } } }, "RegisterVolumeResult": { "type": "structure", "members": { "VolumeId": { "shape": "String", "documentation": "The volume ID.
" } }, "documentation": "Contains the response to a RegisterVolume request.
The operating system family.
" }, "Name": { "shape": "String", "documentation": "The operating system name.
" }, "Version": { "shape": "String", "documentation": "The operating system version.
" } }, "documentation": "A registered instance's reported operating system.
" }, "ResourceArn": { "type": "string" }, "RootDeviceType": { "type": "string", "enum": [ "ebs", "instance-store" ] }, "SelfUserProfile": { "type": "structure", "members": { "IamUserArn": { "shape": "String", "documentation": "The user's IAM ARN.
" }, "Name": { "shape": "String", "documentation": "The user's name.
" }, "SshUsername": { "shape": "String", "documentation": "The user's SSH user name.
" }, "SshPublicKey": { "shape": "String", "documentation": "The user's SSH public key.
" } }, "documentation": "Describes a user's SSH information.
" }, "ServiceError": { "type": "structure", "members": { "ServiceErrorId": { "shape": "String", "documentation": "The error ID.
" }, "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "InstanceId": { "shape": "String", "documentation": "The instance ID.
" }, "Type": { "shape": "String", "documentation": "The error type.
" }, "Message": { "shape": "String", "documentation": "A message that describes the error.
" }, "CreatedAt": { "shape": "DateTime", "documentation": "When the error occurred.
" } }, "documentation": "Describes an OpsWorks Stacks service error.
" }, "ServiceErrors": { "type": "list", "member": { "shape": "ServiceError" } }, "SetLoadBasedAutoScalingRequest": { "type": "structure", "required": [ "LayerId" ], "members": { "LayerId": { "shape": "String", "documentation": "The layer ID.
" }, "Enable": { "shape": "Boolean", "documentation": "Enables load-based auto scaling for the layer.
" }, "UpScaling": { "shape": "AutoScalingThresholds", "documentation": "An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, OpsWorks Stacks starts a specified number of instances.
An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, OpsWorks Stacks stops a specified number of instances.
The stack ID.
" }, "IamUserArn": { "shape": "String", "documentation": "The user's IAM ARN. This can also be a federated user's ARN.
" }, "AllowSsh": { "shape": "Boolean", "documentation": "The user is allowed to use SSH to communicate with the instance.
" }, "AllowSudo": { "shape": "Boolean", "documentation": "The user is allowed to use sudo to elevate privileges.
" }, "Level": { "shape": "String", "documentation": "The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.
deny
show
deploy
manage
iam_only
For more information about the permissions associated with these levels, see Managing User Permissions.
" } } }, "SetTimeBasedAutoScalingRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" }, "AutoScalingSchedule": { "shape": "WeeklyAutoScalingSchedule", "documentation": "An AutoScalingSchedule with the instance schedule.
The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance.
" }, "DelayUntilElbConnectionsDrained": { "shape": "Boolean", "documentation": "Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
" } }, "documentation": "The Shutdown event configuration.
" }, "Source": { "type": "structure", "members": { "Type": { "shape": "SourceType", "documentation": "The repository type.
" }, "Url": { "shape": "String", "documentation": "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.
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.
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.
In requests, the repository's SSH key.
In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
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.
" } }, "documentation": "Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.
" }, "SourceType": { "type": "string", "enum": [ "git", "svn", "archive", "s3" ] }, "SslConfiguration": { "type": "structure", "required": [ "Certificate", "PrivateKey" ], "members": { "Certificate": { "shape": "String", "documentation": "The contents of the certificate's domain.crt file.
" }, "PrivateKey": { "shape": "String", "documentation": "The private key; the contents of the certificate's domain.kex file.
" }, "Chain": { "shape": "String", "documentation": "Optional. Can be used to specify an intermediate certificate authority key or client authentication.
" } }, "documentation": "Describes an app's SSL configuration.
" }, "Stack": { "type": "structure", "members": { "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "Name": { "shape": "String", "documentation": "The stack name. Stack names can be a maximum of 64 characters.
" }, "Arn": { "shape": "String", "documentation": "The stack's ARN.
" }, "Region": { "shape": "String", "documentation": "The stack Amazon Web Services Region, such as ap-northeast-2. For more information about Amazon Web Services Regions, see Regions and Endpoints.
The VPC ID; applicable only if the stack is running in a VPC.
" }, "Attributes": { "shape": "StackAttributes", "documentation": "The stack's attributes.
" }, "ServiceRoleArn": { "shape": "String", "documentation": "The stack Identity and Access Management (IAM) role.
" }, "DefaultInstanceProfileArn": { "shape": "String", "documentation": "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.
" }, "DefaultOs": { "shape": "String", "documentation": "The stack's default operating system.
" }, "HostnameTheme": { "shape": "String", "documentation": "The stack host name theme, with spaces replaced by underscores.
" }, "DefaultAvailabilityZone": { "shape": "String", "documentation": "The stack's default Availability Zone. For more information, see Regions and Endpoints.
" }, "DefaultSubnetId": { "shape": "String", "documentation": "The default subnet ID; applicable only if the stack is running in a VPC.
" }, "CustomJson": { "shape": "String", "documentation": "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.
" }, "ConfigurationManager": { "shape": "StackConfigurationManager", "documentation": "The configuration manager.
" }, "ChefConfiguration": { "shape": "ChefConfiguration", "documentation": "A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
Whether the stack uses custom cookbooks.
" }, "UseOpsworksSecurityGroups": { "shape": "Boolean", "documentation": "Whether the stack automatically associates the OpsWorks Stacks built-in security groups with the stack's layers.
" }, "CustomCookbooksSource": { "shape": "Source", "documentation": "Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
" }, "DefaultSshKeyName": { "shape": "String", "documentation": "A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.
" }, "CreatedAt": { "shape": "DateTime", "documentation": "The date when the stack was created.
" }, "DefaultRootDeviceType": { "shape": "RootDeviceType", "documentation": "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.
" }, "AgentVersion": { "shape": "String", "documentation": "The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.
Describes a stack.
" }, "StackAttributes": { "type": "map", "key": { "shape": "StackAttributesKeys" }, "value": { "shape": "String" } }, "StackAttributesKeys": { "type": "string", "enum": [ "Color" ] }, "StackConfigurationManager": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name. This parameter must be set to Chef.
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.
" } }, "documentation": "Describes the configuration manager.
" }, "StackSummary": { "type": "structure", "members": { "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "Name": { "shape": "String", "documentation": "The stack name.
" }, "Arn": { "shape": "String", "documentation": "The stack's ARN.
" }, "LayersCount": { "shape": "Integer", "documentation": "The number of layers.
" }, "AppsCount": { "shape": "Integer", "documentation": "The number of apps.
" }, "InstancesCount": { "shape": "InstancesCount", "documentation": "An InstancesCount object with the number of instances in each status.
Summarizes the number of layers, instances, and apps in a stack.
" }, "Stacks": { "type": "list", "member": { "shape": "Stack" } }, "StartInstanceRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" } } }, "StartStackRequest": { "type": "structure", "required": [ "StackId" ], "members": { "StackId": { "shape": "String", "documentation": "The stack ID.
" } } }, "StopInstanceRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" }, "Force": { "shape": "Boolean", "documentation": "Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call disassociates the OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the OpsWorks Stacks instance with a new one.
The stack ID.
" } } }, "String": { "type": "string" }, "Strings": { "type": "list", "member": { "shape": "String" } }, "Switch": { "type": "string" }, "TagKey": { "type": "string" }, "TagKeys": { "type": "list", "member": { "shape": "TagKey" } }, "TagResourceRequest": { "type": "structure", "required": [ "ResourceArn", "Tags" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "The stack or layer's Amazon Resource Number (ARN).
" }, "Tags": { "shape": "Tags", "documentation": "A map that contains tag keys and tag values that are attached to a stack or layer.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 40 tags is allowed for any resource.
The user name.
" }, "Password": { "shape": "String", "documentation": "The password.
" }, "ValidForInMinutes": { "shape": "Integer", "documentation": "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.
" }, "InstanceId": { "shape": "String", "documentation": "The instance's OpsWorks Stacks ID.
" } }, "documentation": "Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.
" }, "TimeBasedAutoScalingConfiguration": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" }, "AutoScalingSchedule": { "shape": "WeeklyAutoScalingSchedule", "documentation": "A WeeklyAutoScalingSchedule object with the instance schedule.
Describes an instance's time-based auto scaling configuration.
" }, "TimeBasedAutoScalingConfigurations": { "type": "list", "member": { "shape": "TimeBasedAutoScalingConfiguration" } }, "UnassignInstanceRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" } } }, "UnassignVolumeRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "VolumeId": { "shape": "String", "documentation": "The volume ID.
" } } }, "UntagResourceRequest": { "type": "structure", "required": [ "ResourceArn", "TagKeys" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "The stack or layer's Amazon Resource Number (ARN).
" }, "TagKeys": { "shape": "TagKeys", "documentation": "A list of the keys of tags to be removed from a stack or layer.
" } } }, "UpdateAppRequest": { "type": "structure", "required": [ "AppId" ], "members": { "AppId": { "shape": "String", "documentation": "The app ID.
" }, "Name": { "shape": "String", "documentation": "The app name.
" }, "Description": { "shape": "String", "documentation": "A description of the app.
" }, "DataSources": { "shape": "DataSources", "documentation": "The app's data sources.
" }, "Type": { "shape": "AppType", "documentation": "The app type.
" }, "AppSource": { "shape": "Source", "documentation": "A Source object that specifies the app repository.
The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
Whether SSL is enabled for the app.
" }, "SslConfiguration": { "shape": "SslConfiguration", "documentation": "An SslConfiguration object with the SSL configuration.
One or more user-defined key/value pairs to be added to the stack attributes.
" }, "Environment": { "shape": "EnvironmentVariables", "documentation": "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 variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20 KB).\"
If you have specified one or more environment variables, you cannot modify the stack's Chef version.
The IP address for which you want to update the name.
" }, "Name": { "shape": "String", "documentation": "The new name, which can be a maximum of 32 characters.
" } } }, "UpdateInstanceRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
" }, "LayerIds": { "shape": "Strings", "documentation": "The instance's layer IDs.
" }, "InstanceType": { "shape": "String", "documentation": "The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
" }, "Hostname": { "shape": "String", "documentation": "The instance host name. The following are character limits for instance host names.
Linux-based instances: 63 characters
Windows-based instances: 15 characters
The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.
You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.
The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.
" }, "SshKeyName": { "shape": "String", "documentation": "The instance's Amazon EC2 key name.
" }, "Architecture": { "shape": "Architecture", "documentation": "The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
" }, "InstallUpdatesOnBoot": { "shape": "Boolean", "documentation": "Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to 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.
This property cannot be updated.
" }, "AgentVersion": { "shape": "String", "documentation": "The default OpsWorks Stacks agent version. You have the following options:
INHERIT - Use the stack's default agent version setting.
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance.
The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.
AgentVersion cannot be set to Chef 12.2.
" } } }, "UpdateLayerRequest": { "type": "structure", "required": [ "LayerId" ], "members": { "LayerId": { "shape": "String", "documentation": "The layer ID.
" }, "Name": { "shape": "String", "documentation": "The layer name, which is used by the console. Layer names can be a maximum of 32 characters.
" }, "Shortname": { "shape": "String", "documentation": "For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.
Built-in layer short names are defined by OpsWorks Stacks. For more information, see the Layer reference in the OpsWorks User Guide.
" }, "Attributes": { "shape": "LayerAttributes", "documentation": "One or more user-defined key/value pairs to be added to the stack attributes.
" }, "CloudWatchLogsConfiguration": { "shape": "CloudWatchLogsConfiguration", "documentation": "Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
" }, "CustomInstanceProfileArn": { "shape": "String", "documentation": "The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
" }, "CustomJson": { "shape": "String", "documentation": "A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.
" }, "CustomSecurityGroupIds": { "shape": "Strings", "documentation": "An array containing the layer's custom security group IDs.
" }, "Packages": { "shape": "Strings", "documentation": "An array of Package objects that describe the layer's packages.
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Whether to disable auto healing for the layer.
" }, "AutoAssignElasticIps": { "shape": "Boolean", "documentation": "Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
" }, "AutoAssignPublicIps": { "shape": "Boolean", "documentation": "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.
" }, "CustomRecipes": { "shape": "Recipes", "documentation": "A LayerCustomRecipes object that specifies the layer's custom recipes.
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to 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.
Whether to use Amazon EBS-optimized instances.
" }, "LifecycleEventConfiguration": { "shape": "LifecycleEventConfiguration", "documentation": "" } } }, "UpdateMyUserProfileRequest": { "type": "structure", "members": { "SshPublicKey": { "shape": "String", "documentation": "The user's SSH public key.
" } } }, "UpdateRdsDbInstanceRequest": { "type": "structure", "required": [ "RdsDbInstanceArn" ], "members": { "RdsDbInstanceArn": { "shape": "String", "documentation": "The Amazon RDS instance's ARN.
" }, "DbUser": { "shape": "String", "documentation": "The master user name.
" }, "DbPassword": { "shape": "String", "documentation": "The database password.
" } } }, "UpdateStackRequest": { "type": "structure", "required": [ "StackId" ], "members": { "StackId": { "shape": "String", "documentation": "The stack ID.
" }, "Name": { "shape": "String", "documentation": "The stack's new name. Stack names can be a maximum of 64 characters.
" }, "Attributes": { "shape": "StackAttributes", "documentation": "One or more user-defined key-value pairs to be added to the stack attributes.
" }, "ServiceRoleArn": { "shape": "String", "documentation": "Do not use this parameter. You cannot update a stack's service role.
" }, "DefaultInstanceProfileArn": { "shape": "String", "documentation": "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.
" }, "DefaultOs": { "shape": "String", "documentation": "The stack's operating system, which must be set to one of the following:
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.
The default option is the stack's current operating system. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.
" }, "HostnameTheme": { "shape": "String", "documentation": "The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
" }, "ConfigurationManager": { "shape": "StackConfigurationManager", "documentation": "The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
" }, "ChefConfiguration": { "shape": "ChefConfiguration", "documentation": "A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
Whether the stack uses custom cookbooks.
" }, "CustomCookbooksSource": { "shape": "Source", "documentation": "Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
" }, "DefaultSshKeyName": { "shape": "String", "documentation": "A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
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.
" }, "UseOpsworksSecurityGroups": { "shape": "Boolean", "documentation": "Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:
True - OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
False - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
" }, "AgentVersion": { "shape": "String", "documentation": "The default OpsWorks Stacks agent version. You have the following options:
Auto-update - Set this parameter to LATEST. OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. OpsWorks Stacks installs that version on the stack's instances.
The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
The user IAM ARN. This can also be a federated user's ARN.
" }, "SshUsername": { "shape": "String", "documentation": "The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, OpsWorks Stacks generates one from the IAM user name.
The user's new SSH public key.
" }, "AllowSelfManagement": { "shape": "Boolean", "documentation": "Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
" } } }, "UpdateVolumeRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "VolumeId": { "shape": "String", "documentation": "The volume ID.
" }, "Name": { "shape": "String", "documentation": "The new name. Volume names can be a maximum of 128 characters.
" }, "MountPoint": { "shape": "String", "documentation": "The new mount point.
" } } }, "UserProfile": { "type": "structure", "members": { "IamUserArn": { "shape": "String", "documentation": "The user's IAM ARN.
" }, "Name": { "shape": "String", "documentation": "The user's name.
" }, "SshUsername": { "shape": "String", "documentation": "The user's SSH user name.
" }, "SshPublicKey": { "shape": "String", "documentation": "The user's SSH public key.
" }, "AllowSelfManagement": { "shape": "Boolean", "documentation": "Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
" } }, "documentation": "Describes a user's SSH information.
" }, "UserProfiles": { "type": "list", "member": { "shape": "UserProfile" } }, "ValidForInMinutes": { "type": "integer", "box": true, "max": 1440, "min": 60 }, "VirtualizationType": { "type": "string", "enum": [ "paravirtual", "hvm" ] }, "Volume": { "type": "structure", "members": { "VolumeId": { "shape": "String", "documentation": "The volume ID.
" }, "Ec2VolumeId": { "shape": "String", "documentation": "The Amazon EC2 volume ID.
" }, "Name": { "shape": "String", "documentation": "The volume name. Volume names are a maximum of 128 characters.
" }, "RaidArrayId": { "shape": "String", "documentation": "The RAID array ID.
" }, "InstanceId": { "shape": "String", "documentation": "The instance ID.
" }, "Status": { "shape": "String", "documentation": "The value returned by DescribeVolumes.
" }, "Size": { "shape": "Integer", "documentation": "The volume size.
" }, "Device": { "shape": "String", "documentation": "The device name.
" }, "MountPoint": { "shape": "String", "documentation": "The volume mount point. For example, \"/mnt/disk1\".
" }, "Region": { "shape": "String", "documentation": "The Amazon Web Services Region. For more information about Amazon Web Services Regions, see Regions and Endpoints.
" }, "AvailabilityZone": { "shape": "String", "documentation": "The volume Availability Zone. For more information, see Regions and Endpoints.
" }, "VolumeType": { "shape": "String", "documentation": "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.
For PIOPS volumes, the IOPS per disk.
" }, "Encrypted": { "shape": "Boolean", "documentation": "Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
" } }, "documentation": "Describes an instance's Amazon EBS volume.
" }, "VolumeConfiguration": { "type": "structure", "required": [ "MountPoint", "NumberOfDisks", "Size" ], "members": { "MountPoint": { "shape": "String", "documentation": "The volume mount point. For example \"/dev/sdh\".
" }, "RaidLevel": { "shape": "Integer", "documentation": "The volume RAID level.
" }, "NumberOfDisks": { "shape": "Integer", "documentation": "The number of disks in the volume.
" }, "Size": { "shape": "Integer", "documentation": "The volume size.
" }, "VolumeType": { "shape": "String", "documentation": "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.
For PIOPS volumes, the IOPS per disk.
" }, "Encrypted": { "shape": "Boolean", "documentation": "Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
" } }, "documentation": "Describes an Amazon EBS volume configuration.
" }, "VolumeConfigurations": { "type": "list", "member": { "shape": "VolumeConfiguration" } }, "VolumeType": { "type": "string", "enum": [ "gp2", "io1", "standard" ] }, "Volumes": { "type": "list", "member": { "shape": "Volume" } }, "WeeklyAutoScalingSchedule": { "type": "structure", "members": { "Monday": { "shape": "DailyAutoScalingSchedule", "documentation": "The schedule for Monday.
" }, "Tuesday": { "shape": "DailyAutoScalingSchedule", "documentation": "The schedule for Tuesday.
" }, "Wednesday": { "shape": "DailyAutoScalingSchedule", "documentation": "The schedule for Wednesday.
" }, "Thursday": { "shape": "DailyAutoScalingSchedule", "documentation": "The schedule for Thursday.
" }, "Friday": { "shape": "DailyAutoScalingSchedule", "documentation": "The schedule for Friday.
" }, "Saturday": { "shape": "DailyAutoScalingSchedule", "documentation": "The schedule for Saturday.
" }, "Sunday": { "shape": "DailyAutoScalingSchedule", "documentation": "The schedule for Sunday.
" } }, "documentation": "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\" }
Welcome to the OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for OpsWorks Stacks actions and data types, including common parameters and error codes.
OpsWorks Stacks is an application management service that provides an integrated experience for managing the complete application lifecycle. For information about OpsWorks, see the OpsWorks information page.
SDKs and CLI
Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:
Endpoints
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 Amazon Web Services Management 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.