openstack.orchestration.v1.stack

openstack.orchestration.v1.stack

The Stack Class

The Stack class inherits from Resource.

class openstack.orchestration.v1.stack.Stack(_synchronized=False, **attrs)

The base resource

Parameters:_synchronized (bool) – This is not intended to be used directly. See new() and existing().
capabilities = None

Placeholder for AWS compatible template listing capabilities required by the stack.

created_at = None

Timestamp of the stack creation.

description = None

A text description of the stack.

is_rollback_disabled = None

Whether the stack will support a rollback operation on stack create/update failures. Type: bool

A list of dictionaries containing links relevant to the stack.

name = None

Name of the stack.

notification_topics = None

Placeholder for future extensions where stack related events can be published.

outputs = None

A list containing output keys and values from the stack, if any.

owner_id = None

The ID of the owner stack if any.

parameters = None

A dictionary containing the parameter names and values for the stack.

parent_id = None

The ID of the parent stack if any

status = None

A string representation of the stack status, e.g. CREATE_COMPLETE.

status_reason = None

A text explaining how the stack transits to its current status.

tags = None

A list of strings used as tags on the stack

template = None

A dict containing the template use for stack creation.

template_description = None

Stack template description text. Currently contains the same text as that of the description property.

template_url = None

A string containing the URL where a stack template can be found.

timeout_mins = None

Stack operation timeout in minutes.

updated_at = None

Timestamp of last update on the stack.

user_project_id = None

The ID of the user project created for this stack.

create(session)

Create a remote resource based on this instance.

Parameters:
  • session (Adapter) – The session to use for making this request.
  • prepend_key – A boolean indicating whether the resource_key should be prepended in a resource creation request. Default to True.
Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_create is not set to True.

update(session)

Update the remote resource based on this instance.

Parameters:
  • session (Adapter) – The session to use for making this request.
  • prepend_key – A boolean indicating whether the resource_key should be prepended in a resource update request. Default to True.
Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_update is not set to True.

get(session, requires_id=True, error_message=None)

Get a remote resource based on this instance.

Parameters:
  • session (Adapter) – The session to use for making this request.
  • requires_id (boolean) – A boolean indicating whether resource ID should be part of the requested URI.
Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_get is not set to True.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.