aarm

README

aarm

AWS App Runner Manager

Documentation

Index

• func CLI(ctx context.Context, args []string) (int, error)
• type App
  • func NewApp(ctx context.Context, opts *GlobalOptions) (*App, error)
  • func (app *App) Deploy(ctx context.Context, opts *DeployOption) error
  • func (app *App) Diff(ctx context.Context, opts *DiffOption) error
  • func (app *App) Init(ctx context.Context, opts *InitOption) error
  • func (app *App) Log(f string, v ...any)
  • func (app *App) Render(ctx context.Context, opts *RenderOption) error
• type AuthenticationConfiguration
• type CodeConfiguration
• type CodeConfigurationValues
• type CodeRepository
• type DeployOption
  • func (opts *DeployOption) Install(set *flag.FlagSet)
• type DiffOption
  • func (opts *DiffOption) Install(set *flag.FlagSet)
• type EgressConfiguration
• type EncryptionConfiguration
• type GlobalOptions
  • func (opts *GlobalOptions) Install(set *flag.FlagSet)
• type HealthCheckConfiguration
• type ImageConfiguration
• type ImageRepository
• type IngressConfiguration
• type InitOption
  • func (opts *InitOption) Install(set *flag.FlagSet)
• type InstanceConfiguration
• type NetworkConfiguration
• type RenderOption
  • func (opts *RenderOption) Install(set *flag.FlagSet)
• type Service
• type ServiceObservabilityConfiguration
• type SourceCodeVersion
• type SourceConfiguration

Functions

func CLI

func CLI(ctx context.Context, args []string) (int, error)

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func NewApp

func NewApp(ctx context.Context, opts *GlobalOptions) (*App, error)

func (*App) Deploy

func (app *App) Deploy(ctx context.Context, opts *DeployOption) error

func (*App) Diff

func (app *App) Diff(ctx context.Context, opts *DiffOption) error

func (*App) Init

func (app *App) Init(ctx context.Context, opts *InitOption) error

func (*App) Log

func (app *App) Log(f string, v ...any)

func (*App) Render

func (app *App) Render(ctx context.Context, opts *RenderOption) error

type AuthenticationConfiguration

type AuthenticationConfiguration struct {
	AccessRoleArn *string `json:",omitempty"`
	ConnectionArn *string `json:",omitempty"`
}

type CodeConfiguration

type CodeConfiguration struct {
	CodeConfigurationValues *CodeConfigurationValues  `json:",omitempty"`
	ConfigurationSource     types.ConfigurationSource `json:",omitempty"`
}

type CodeConfigurationValues

type CodeConfigurationValues struct {
	BuildCommand                *string           `json:",omitempty"`
	Port                        *string           `json:",omitempty"`
	Runtime                     types.Runtime     `json:",omitempty"`
	RuntimeEnvironmentVariables map[string]string `json:",omitempty"`
	StartCommand                *string           `json:",omitempty"`
}

type CodeRepository

type CodeRepository struct {
	CodeConfiguration *CodeConfiguration `json:",omitempty"`
	RepositoryUrl     *string            `json:",omitempty"`
	SourceCodeVersion *SourceCodeVersion `json:",omitempty"`
}

type DeployOption

type DeployOption struct {
	GlobalOptions
}

func (*DeployOption) Install

func (opts *DeployOption) Install(set *flag.FlagSet)

type DiffOption

type DiffOption struct {
	GlobalOptions
}

func (*DiffOption) Install

func (opts *DiffOption) Install(set *flag.FlagSet)

type EgressConfiguration

type EgressConfiguration struct {
	EgressType      types.EgressType
	VpcConnectorArn *string
}

type EncryptionConfiguration

type EncryptionConfiguration struct {
	KmsKey *string
}

type GlobalOptions

type GlobalOptions struct {
	Region     string
	Profile    string
	Debug      bool
	ConfigPath string
	ExtStr     keyValuesOptions
	ExtCode    keyValuesOptions
}

func (*GlobalOptions) Install

func (opts *GlobalOptions) Install(set *flag.FlagSet)

type HealthCheckConfiguration

type HealthCheckConfiguration struct {
	HealthyThreshold   *int32
	Interval           *int32
	Path               *string
	Protocol           types.HealthCheckProtocol
	Timeout            *int32
	UnhealthyThreshold *int32
}

type ImageConfiguration

type ImageConfiguration struct {
	Port                        *string           `json:",omitempty"`
	RuntimeEnvironmentVariables map[string]string `json:",omitempty"`
	StartCommand                *string           `json:",omitempty"`
}

type ImageRepository

type ImageRepository struct {
	ImageConfiguration  *ImageConfiguration       `json:",omitempty"`
	ImageIdentifier     *string                   `json:",omitempty"`
	ImageRepositoryType types.ImageRepositoryType `json:",omitempty"`
}

type IngressConfiguration

type IngressConfiguration struct {
	IsPubliclyAccessible bool
}

type InitOption

type InitOption struct {
	GlobalOptions
	ServiceArn  string
	ServiceName string
}

func (*InitOption) Install

func (opts *InitOption) Install(set *flag.FlagSet)

type InstanceConfiguration

type InstanceConfiguration struct {
	Cpu             *string `json:",omitempty"`
	InstanceRoleArn *string `json:",omitempty"`
	Memory          *string `json:",omitempty"`
}

type NetworkConfiguration

type NetworkConfiguration struct {
	// Network configuration settings for outbound message traffic.
	EgressConfiguration *EgressConfiguration `json:",omitempty"`

	// Network configuration settings for inbound message traffic.
	IngressConfiguration *IngressConfiguration `json:",omitempty"`
}

type RenderOption

type RenderOption struct {
	GlobalOptions
}

func (*RenderOption) Install

func (opts *RenderOption) Install(set *flag.FlagSet)

type Service

type Service struct {
	ServiceName                 *string                            `json:",omitempty"`
	SourceConfiguration         *SourceConfiguration               `json:",omitempty"`
	AutoScalingConfigurationArn *string                            `json:",omitempty"`
	EncryptionConfiguration     *EncryptionConfiguration           `json:",omitempty"`
	HealthCheckConfiguration    *HealthCheckConfiguration          `json:",omitempty"`
	InstanceConfiguration       *InstanceConfiguration             `json:",omitempty"`
	NetworkConfiguration        *NetworkConfiguration              `json:",omitempty"`
	ObservabilityConfiguration  *ServiceObservabilityConfiguration `json:",omitempty"`
}

type ServiceObservabilityConfiguration

type ServiceObservabilityConfiguration struct {
	ObservabilityEnabled          bool
	ObservabilityConfigurationArn *string
}

type SourceCodeVersion

type SourceCodeVersion struct {
	Type  types.SourceCodeVersionType `json:",omitempty"`
	Value *string                     `json:",omitempty"`
}

type SourceConfiguration

type SourceConfiguration struct {
	AuthenticationConfiguration *AuthenticationConfiguration `json:",omitempty"`
	AutoDeploymentsEnabled      *bool                        `json:",omitempty"`
	CodeRepository              *CodeRepository              `json:",omitempty"`
	ImageRepository             *ImageRepository             `json:",omitempty"`
}