deptemplateapi

Documentation

Index

• func Create(params CreateParams) (string, error)
• func Delete(params DeleteParams) error
• func Get(params GetParams) (*models.DeploymentTemplateInfoV2, error)
• func List(params ListParams) ([]*models.DeploymentTemplateInfoV2, error)
• func Update(params UpdateParams) error
• type CreateParams
  • func (params CreateParams) Validate() error
• type DeleteParams
  • func (params DeleteParams) Validate() error
• type GetParams
  • func (params GetParams) Validate() error
• type ListParams
  • func (params ListParams) Validate() error
• type UpdateParams
  • func (params UpdateParams) Validate() error

Functions

func Create

func Create(params CreateParams) (string, error)

Create creates a deployment template from a definition. If a TemplateID is specified in the params then it uses the "PUT" version of the call which will create a deployment template with the specified id, if the ID already exists, it'll return an error.

func Delete

func Delete(params DeleteParams) error

Delete removes an existing deployment temeplate.

func Get

func Get(params GetParams) (*models.DeploymentTemplateInfoV2, error)

Get returns the specified deployment template.

func List

func List(params ListParams) ([]*models.DeploymentTemplateInfoV2, error)

List returns a list of the available deployment templates.

func Update

func Update(params UpdateParams) error

Update updates an existing deployment template from a definition.

Types

type CreateParams

type CreateParams struct {
	*api.API

	Region     string
	TemplateID string
	Request    *models.DeploymentTemplateRequestBody
}

CreateParams is consumed by the Create function.

func (CreateParams) Validate

func (params CreateParams) Validate() error

Validate ensures the parameters are usable by Create.

type DeleteParams

type DeleteParams struct {
	*api.API

	TemplateID string
	Region     string
}

DeleteParams is consumed by the Delete function.

func (DeleteParams) Validate

func (params DeleteParams) Validate() error

Validate ensures the parameters are usable by Delete.

type GetParams

type GetParams struct {
	*api.API

	TemplateID   string
	Region       string
	StackVersion string

	HideInstanceConfigurations bool
	ShowMaxZones               bool
}

GetParams is consumed by the Get function.

func (GetParams) Validate

func (params GetParams) Validate() error

Validate ensures the parameters are usable by Get.

type ListParams

type ListParams struct {
	*api.API

	MetadataFilter string
	Region         string
	StackVersion   string

	ShowHidden                 bool
	HideInstanceConfigurations bool
	ShowMaxZones               bool
}

ListParams is consumed by the List function.

func (ListParams) Validate

func (params ListParams) Validate() error

Validate ensures the parameters are usable by List.

type UpdateParams

type UpdateParams struct {
	*api.API

	Region     string
	TemplateID string
	Request    *models.DeploymentTemplateRequestBody
}

UpdateParams is consumed by the Update function.

func (UpdateParams) Validate

func (params UpdateParams) Validate() error

Validate ensures the parameters are usable by Update.