Documentation
¶
Overview ¶
Package apprunner provides a client to make API requests to AppRunner Service.
Package apprunner provides a client to make API requests to AppRunner Service.
Index ¶
- Constants
- func DetermineImageRepositoryType(imageIdentifier string) (string, error)
- func ImageIsSupported(imageIdentifier string) bool
- func LogGroupName(svcARN string) (string, error)
- func ParseServiceID(svcARN string) (string, error)
- func ParseServiceName(svcARN string) (string, error)
- func SystemLogGroupName(svcARN string) (string, error)
- type AppRunner
- func (a *AppRunner) DescribeOperation(operationId, svcARN string) (*apprunner.OperationSummary, error)
- func (a *AppRunner) DescribeService(svcARN string) (*Service, error)
- func (a *AppRunner) PauseService(svcARN string) error
- func (a *AppRunner) PrivateURL(vicARN string) (string, error)
- func (a *AppRunner) ResumeService(svcARN string) error
- func (a *AppRunner) ServiceARN(svc string) (string, error)
- func (a *AppRunner) StartDeployment(svcARN string) (string, error)
- func (a *AppRunner) WaitForOperation(operationId, svcARN string) error
- type EnvironmentSecret
- type EnvironmentVariable
- type ErrWaitServiceOperationFailed
- type ObservabilityConfiguration
- type Service
- type TraceConfiguration
Constants ¶
const ( // EndpointsID is the ID to look up the App Runner service endpoint. EndpointsID = apprunner.EndpointsID )
Variables ¶
This section is empty.
Functions ¶
func DetermineImageRepositoryType ¶
DetermineImageRepositoryType returns the App Runner ImageRepositoryType enum value for the provided image identifier, or returns an error if the imageIdentifier is not supported by App Runner or the ImageRepositoryType cannot be determined.
func ImageIsSupported ¶
ImageIsSupported returns true if the image identifier is supported by App Runner.
func LogGroupName ¶
LogGroupName returns the log group name given the app runner service's name. An application log group is formatted as "/aws/apprunner/<svcName>/<svcID>/application".
func ParseServiceID ¶
ParseServiceID returns the service id. For example: arn:aws:apprunner:us-west-2:1234567890:service/my-service/fc1098ac269245959ba78fd58bdd4bf will return fc1098ac269245959ba78fd58bdd4bf
func ParseServiceName ¶
ParseServiceName returns the service name. For example: arn:aws:apprunner:us-west-2:1234567890:service/my-service/fc1098ac269245959ba78fd58bdd4bf will return my-service
func SystemLogGroupName ¶
SystemLogGroupName returns the service log group name given the app runner service's name. A service log group is formatted as "/aws/apprunner/<svcName>/<svcID>/service".
Types ¶
type AppRunner ¶
type AppRunner struct {
// contains filtered or unexported fields
}
AppRunner wraps an AWS AppRunner client.
func (*AppRunner) DescribeOperation ¶
func (a *AppRunner) DescribeOperation(operationId, svcARN string) (*apprunner.OperationSummary, error)
DescribeOperation return OperationSummary for given OperationId and ServiceARN.
func (*AppRunner) DescribeService ¶
DescribeService returns a description of an AppRunner service given its ARN.
func (*AppRunner) PauseService ¶
PauseService pause the running App Runner service.
func (*AppRunner) PrivateURL ¶ added in v1.23.0
PrivateURL returns the url associated with a VPC Ingress Connection.
func (*AppRunner) ResumeService ¶
ResumeService resumes a paused App Runner service.
func (*AppRunner) ServiceARN ¶
ServiceARN returns the ARN of an AppRunner service given its service name.
func (*AppRunner) StartDeployment ¶ added in v1.10.0
StartDeployment initiates a manual deployment to an AWS App Runner service.
func (*AppRunner) WaitForOperation ¶ added in v1.10.0
WaitForOperation waits for a service operation.
type EnvironmentSecret ¶ added in v1.26.0
EnvironmentSecret contains the name and value of a Secret from SSM Parameter Store or Secrets Manager.
type EnvironmentVariable ¶
EnvironmentVariable contains the name and value of an environment variable.
type ErrWaitServiceOperationFailed ¶ added in v1.10.0
type ErrWaitServiceOperationFailed struct {
// contains filtered or unexported fields
}
ErrWaitServiceOperationFailed occurs when the service operation failed.
func (*ErrWaitServiceOperationFailed) Error ¶ added in v1.10.0
func (e *ErrWaitServiceOperationFailed) Error() string
func (*ErrWaitServiceOperationFailed) Timeout ¶ added in v1.10.0
func (e *ErrWaitServiceOperationFailed) Timeout() bool
Timeout allows ErrWaitServiceOperationFailed to implement a timeout error interface.
type ObservabilityConfiguration ¶ added in v1.18.0
type ObservabilityConfiguration struct {
TraceConfiguration *TraceConfiguration
}
ObservabilityConfiguration contains observability related configuration. Currently only tracing configuration is available.
type Service ¶
type Service struct {
ServiceARN string
Name string
ID string
Status string
ServiceURL string
DateCreated time.Time
DateUpdated time.Time
CPU string
Memory string
ImageID string
Port string
EnvironmentVariables []*EnvironmentVariable
Observability ObservabilityConfiguration
EnvironmentSecrets []*EnvironmentSecret
}
Service wraps up AppRunner Service struct.
type TraceConfiguration ¶ added in v1.18.0
type TraceConfiguration apprunner.TraceConfiguration
TraceConfiguration wraps AppRunner TraceConfiguration.
Source Files
Directories