Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Enum
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
    • Queues
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

  • Resource
  • Service
  • Stack
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class Stack

The Stack class requires a CloudFormation template and may contain additional parameters for that template.

A Stack is always associated with an (Orchestration) Service.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Resource\BaseResource
Extended by OpenCloud\Common\Resource\PersistentResource
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\Orchestration\Stack
Namespace: OpenCloud\Orchestration
CodeCoverageIgnore
Located at OpenCloud/Orchestration/Stack.php
Methods summary
protected object
# createJson( )

Provides JSON for create request body

Provides JSON for create request body

Returns

object

Throws

RuntimeException

Overrides

OpenCloud\Common\Resource\PersistentResource::createJson()
public
# resource( mixed $id = null )
public
# resources( )
Methods inherited from OpenCloud\Common\Resource\PersistentResource
checkExtension(), create(), delete(), getAlias(), noCreate(), noDelete(), noUpdate(), refresh(), refreshFromLocationUrl(), update(), updateJson(), waitFor()
Methods inherited from OpenCloud\Common\Resource\BaseResource
__construct(), findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), jsonCollectionElement(), jsonCollectionName(), jsonName(), parseResponse(), primaryKeyField(), resourceName(), setMetadata(), setParent(), setService()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getProperty(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Properties summary
protected string $id
#

Identifier of stack.

Identifier of stack.

protected string $stack_name
#

The name associated with the stack. Must be unique within your account, contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

The name associated with the stack. Must be unique within your account, contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

protected mixed $parameters
#

A list of Parameter structures that specify input parameters for the stack.

A list of Parameter structures that specify input parameters for the stack.

protected string $template
#

Structure containing the template body.

Structure containing the template body.

protected boolean $disable_rollback
#

Set to true to disable rollback of the stack if stack creation failed.

Set to true to disable rollback of the stack if stack creation failed.

protected string $description
#

Description of stack.

Description of stack.

protected type $stack_status_reason
#
protected type $outputs
#
protected type $creation_time
#
protected array $links
#

Array of stack lists.

Array of stack lists.

protected mixed $capabilities
#

The list of capabilities that you want to allow in the stack.

The list of capabilities that you want to allow in the stack.

protected mixed $notification_topics
#

The Simple Notification Service topic ARNs to publish stack related events.

The Simple Notification Service topic ARNs to publish stack related events.

protected string $timeout_mins
#

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

protected type $stack_status
#
protected type $updated_time
#
protected type $template_description
#
protected static string $json_name "stack"
#
protected static string $url_resource "stacks"
#
protected array $createKeys array( 'template', 'stack_name' )
#
Properties inherited from OpenCloud\Common\Resource\BaseResource
$metadata, $parent, $service
Properties inherited from OpenCloud\Common\Base
$aliases
PHP OpenCloud API API documentation generated by ApiGen 2.8.0