s3

Documentation

Overview

Package s3 contains commands to inspect and manipulate Fastly service S3 logging endpoints.

Index

• type CreateCommand
  • func NewCreateCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *CreateCommand
  • func (c *CreateCommand) ConstructInput(serviceID string, serviceVersion int) (*fastly.CreateS3Input, error)
  • func (c *CreateCommand) Exec(in io.Reader, out io.Writer) error
• type DeleteCommand
  • func NewDeleteCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *DeleteCommand
  • func (c *DeleteCommand) Exec(in io.Reader, out io.Writer) error
• type DescribeCommand
  • func NewDescribeCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *DescribeCommand
  • func (c *DescribeCommand) Exec(in io.Reader, out io.Writer) error
• type ListCommand
  • func NewListCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *ListCommand
  • func (c *ListCommand) Exec(in io.Reader, out io.Writer) error
• type RootCommand
  • func NewRootCommand(parent cmd.Registerer, globals *config.Data) *RootCommand
  • func (c *RootCommand) Exec(in io.Reader, out io.Writer) error
• type UpdateCommand
  • func NewUpdateCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *UpdateCommand
  • func (c *UpdateCommand) ConstructInput(serviceID string, serviceVersion int) (*fastly.UpdateS3Input, error)
  • func (c *UpdateCommand) Exec(in io.Reader, out io.Writer) error

Types

type CreateCommand

type CreateCommand struct {
	cmd.Base
	Manifest manifest.Data

	// required
	EndpointName   string // Can't shadow cmd.Base method Name().
	BucketName     string
	ServiceName    cmd.OptionalServiceNameID
	ServiceVersion cmd.OptionalServiceVersion

	// mutual exclusions
	// AccessKey + SecretKey or IAMRole must be provided
	AccessKey cmd.OptionalString
	SecretKey cmd.OptionalString
	IAMRole   cmd.OptionalString

	// optional
	AutoClone                    cmd.OptionalAutoClone
	Domain                       cmd.OptionalString
	Path                         cmd.OptionalString
	Period                       cmd.OptionalUint
	GzipLevel                    cmd.OptionalUint
	Format                       cmd.OptionalString
	FormatVersion                cmd.OptionalUint
	MessageType                  cmd.OptionalString
	ResponseCondition            cmd.OptionalString
	TimestampFormat              cmd.OptionalString
	Placement                    cmd.OptionalString
	Redundancy                   cmd.OptionalString
	PublicKey                    cmd.OptionalString
	ServerSideEncryption         cmd.OptionalString
	ServerSideEncryptionKMSKeyID cmd.OptionalString
	CompressionCodec             cmd.OptionalString
}

CreateCommand calls the Fastly API to create an Amazon S3 logging endpoint.

func NewCreateCommand

func NewCreateCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *CreateCommand

NewCreateCommand returns a usable command registered under the parent.

func (*CreateCommand) ConstructInput

func (c *CreateCommand) ConstructInput(serviceID string, serviceVersion int) (*fastly.CreateS3Input, error)

ConstructInput transforms values parsed from CLI flags into an object to be used by the API client library.

func (*CreateCommand) Exec

func (c *CreateCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.

type DeleteCommand

type DeleteCommand struct {
	cmd.Base

	Input fastly.DeleteS3Input
	// contains filtered or unexported fields
}

DeleteCommand calls the Fastly API to delete an Amazon S3 logging endpoint.

func NewDeleteCommand

func NewDeleteCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *DeleteCommand

NewDeleteCommand returns a usable command registered under the parent.

func (*DeleteCommand) Exec

func (c *DeleteCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.

type DescribeCommand

type DescribeCommand struct {
	cmd.Base

	Input fastly.GetS3Input
	// contains filtered or unexported fields
}

DescribeCommand calls the Fastly API to describe an Amazon S3 logging endpoint.

func NewDescribeCommand

func NewDescribeCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *DescribeCommand

NewDescribeCommand returns a usable command registered under the parent.

func (*DescribeCommand) Exec

func (c *DescribeCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.

type ListCommand

type ListCommand struct {
	cmd.Base

	Input fastly.ListS3sInput
	// contains filtered or unexported fields
}

ListCommand calls the Fastly API to list Amazon S3 logging endpoints.

func NewListCommand

func NewListCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *ListCommand

NewListCommand returns a usable command registered under the parent.

func (*ListCommand) Exec

func (c *ListCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.

type RootCommand

type RootCommand struct {
	cmd.Base
}

RootCommand is the parent command for all subcommands in this package. It should be installed under the primary root command.

func NewRootCommand

func NewRootCommand(parent cmd.Registerer, globals *config.Data) *RootCommand

NewRootCommand returns a new command registered in the parent.

func (*RootCommand) Exec

func (c *RootCommand) Exec(in io.Reader, out io.Writer) error

Exec implements the command interface.

type UpdateCommand

type UpdateCommand struct {
	cmd.Base
	Manifest manifest.Data

	// required
	EndpointName   string // Can't shadow cmd.Base method Name().
	ServiceName    cmd.OptionalServiceNameID
	ServiceVersion cmd.OptionalServiceVersion

	// optional
	AutoClone                    cmd.OptionalAutoClone
	NewName                      cmd.OptionalString
	Address                      cmd.OptionalString
	BucketName                   cmd.OptionalString
	AccessKey                    cmd.OptionalString
	SecretKey                    cmd.OptionalString
	IAMRole                      cmd.OptionalString
	Domain                       cmd.OptionalString
	Path                         cmd.OptionalString
	Period                       cmd.OptionalUint
	GzipLevel                    cmd.OptionalUint
	Format                       cmd.OptionalString
	FormatVersion                cmd.OptionalUint
	MessageType                  cmd.OptionalString
	ResponseCondition            cmd.OptionalString
	TimestampFormat              cmd.OptionalString
	Placement                    cmd.OptionalString
	PublicKey                    cmd.OptionalString
	Redundancy                   cmd.OptionalString
	ServerSideEncryption         cmd.OptionalString
	ServerSideEncryptionKMSKeyID cmd.OptionalString
	CompressionCodec             cmd.OptionalString
}

UpdateCommand calls the Fastly API to update an Amazon S3 logging endpoint.

func NewUpdateCommand

func NewUpdateCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *UpdateCommand

NewUpdateCommand returns a usable command registered under the parent.

func (*UpdateCommand) ConstructInput

func (c *UpdateCommand) ConstructInput(serviceID string, serviceVersion int) (*fastly.UpdateS3Input, error)

ConstructInput transforms values parsed from CLI flags into an object to be used by the API client library.

func (*UpdateCommand) Exec

func (c *UpdateCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.