configurationtemplateapi

Documentation

Index

• func CreateTemplate(params CreateTemplateParams) (string, error)
• func DeleteTemplate(params DeleteTemplateParams) error
• func GetTemplate(params GetTemplateParams) (*models.DeploymentTemplateInfoV2, error)
• func ListTemplates(params ListTemplateParams) ([]*models.DeploymentTemplateInfoV2, error)
• func PullToFolder(params PullToFolderParams) error
• func UpdateTemplate(params UpdateTemplateParams) error
• type CreateTemplateParams
  • func (params CreateTemplateParams) Validate() error
• type DeleteTemplateParams
  • func (params DeleteTemplateParams) Validate() error
• type GetTemplateParams
  • func (params *GetTemplateParams) Validate() error
• type ListTemplateParams
  • func (params *ListTemplateParams) Validate() error
• type PullToFolderParams
  • func (params PullToFolderParams) Validate() error
• type UpdateTemplateParams
  • func (params UpdateTemplateParams) Validate() error

Functions

func CreateTemplate

func CreateTemplate(params CreateTemplateParams) (string, error)

CreateTemplate creates a platform deployment template

func DeleteTemplate

func DeleteTemplate(params DeleteTemplateParams) error

DeleteTemplate deletes a specific platform deployment template

func GetTemplate

func GetTemplate(params GetTemplateParams) (*models.DeploymentTemplateInfoV2, error)

GetTemplate obtains information about a specific platform deployment template

func ListTemplates

func ListTemplates(params ListTemplateParams) ([]*models.DeploymentTemplateInfoV2, error)

ListTemplates obtains all the configured platform deployment templates

func PullToFolder

func PullToFolder(params PullToFolderParams) error

PullToFolder downloads deployment templates and save them in a local folder

func UpdateTemplate

func UpdateTemplate(params UpdateTemplateParams) error

UpdateTemplate updates a platform deployment template

Types

type CreateTemplateParams

type CreateTemplateParams struct {
	*api.API
	ID string
	*models.DeploymentTemplateRequestBody
	Region string
}

CreateTemplateParams is the parameter of template create sub-command

func (CreateTemplateParams) Validate

func (params CreateTemplateParams) Validate() error

Validate is the implementation for the ecctl.Validator interface

type DeleteTemplateParams

type DeleteTemplateParams struct {
	*api.API
	ID     string
	Region string
}

DeleteTemplateParams is the parameter of template show sub-command

func (DeleteTemplateParams) Validate

func (params DeleteTemplateParams) Validate() error

Validate is the implementation for the ecctl.Validator interface

type GetTemplateParams

type GetTemplateParams struct {
	*api.API

	ID     string
	Region string

	// If true, will return details for each instance configuration referenced by the template.
	ShowInstanceConfig bool
}

GetTemplateParams is the parameter of template show sub-command

func (*GetTemplateParams) Validate

func (params *GetTemplateParams) Validate() error

Validate is the implementation for the ecctl.Validator interface

type ListTemplateParams

type ListTemplateParams struct {
	*api.API
	Region string

	// If true, will return details for each instance configuration referenced by the template.
	ShowInstanceConfig bool

	// If present, it will cause the returned deployment templates to be adapted to return only the elements allowed
	// in that version.
	StackVersion string

	// An optional key/value pair in the form of (key:value) that will act as a filter and exclude any templates
	// that do not have a matching metadata item associated.
	Metadata string
}

ListTemplateParams is the parameter of template list sub-command

func (*ListTemplateParams) Validate

func (params *ListTemplateParams) Validate() error

Validate is the implementation for the ecctl.Validator interface

type PullToFolderParams

type PullToFolderParams struct {
	*api.API
	Folder             string
	Region             string
	Format             string
	ShowInstanceConfig bool
}

PullToFolderParams is the parameter for deployment template pull to folder sub-command

func (PullToFolderParams) Validate

func (params PullToFolderParams) Validate() error

Validate is the implementation for the ecctl.Validator interface

type UpdateTemplateParams

type UpdateTemplateParams struct {
	*api.API
	ID string
	*models.DeploymentTemplateRequestBody
	Region string
}

UpdateTemplateParams is the parameter of template update sub-command

func (UpdateTemplateParams) Validate

func (params UpdateTemplateParams) Validate() error

Validate is the implementation for the ecctl.Validator interface