types

package
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthenticationConfiguration 

type AuthenticationConfiguration struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants the App Runner
	// service access to a source repository. It's required for ECR image repositories
	// (but not for ECR Public repositories).
	AccessRoleArn *string

	// The Amazon Resource Name (ARN) of the App Runner connection that enables the
	// App Runner service to connect to a source repository. It's required for GitHub
	// code repositories.
	ConnectionArn *string
	// contains filtered or unexported fields
}

Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.

type AutoScalingConfiguration 

type AutoScalingConfiguration struct {

	// The Amazon Resource Name (ARN) of this auto scaling configuration.
	AutoScalingConfigurationArn *string

	// The customer-provided auto scaling configuration name. It can be used in
	// multiple revisions of a configuration.
	AutoScalingConfigurationName *string

	// The revision of this auto scaling configuration. It's unique among all the
	// active configurations ( "Status": "ACTIVE" ) that share the same
	// AutoScalingConfigurationName .
	AutoScalingConfigurationRevision *int32

	// The time when the auto scaling configuration was created. It's in Unix time
	// stamp format.
	CreatedAt *time.Time

	// The time when the auto scaling configuration was deleted. It's in Unix time
	// stamp format.
	DeletedAt *time.Time

	// Indicates if this auto scaling configuration has an App Runner service
	// associated with it. A value of true indicates one or more services are
	// associated. A value of false indicates no services are associated.
	HasAssociatedService *bool

	// Indicates if this auto scaling configuration should be used as the default for
	// a new App Runner service that does not have an auto scaling configuration ARN
	// specified during creation. Each account can have only one default
	// AutoScalingConfiguration per region. The default AutoScalingConfiguration can
	// be any revision under the same AutoScalingConfigurationName .
	IsDefault *bool

	// It's set to true for the configuration with the highest Revision among all
	// configurations that share the same AutoScalingConfigurationName . It's set to
	// false otherwise.
	Latest *bool

	// The maximum number of concurrent requests that an instance processes. If the
	// number of concurrent requests exceeds this limit, App Runner scales the service
	// up.
	MaxConcurrency *int32

	// The maximum number of instances that a service scales up to. At most MaxSize
	// instances actively serve traffic for your service.
	MaxSize *int32

	// The minimum number of instances that App Runner provisions for a service. The
	// service always has at least MinSize provisioned instances. Some of them
	// actively serve traffic. The rest of them (provisioned and inactive instances)
	// are a cost-effective compute capacity reserve and are ready to be quickly
	// activated. You pay for memory usage of all the provisioned instances. You pay
	// for CPU usage of only the active subset.
	//
	// App Runner temporarily doubles the number of provisioned instances during
	// deployments, to maintain the same capacity for both old and new code.
	MinSize *int32

	// The current state of the auto scaling configuration. If the status of a
	// configuration revision is INACTIVE , it was deleted and can't be used. Inactive
	// configuration revisions are permanently removed some time after they are
	// deleted.
	Status AutoScalingConfigurationStatus
	// contains filtered or unexported fields
}

Describes an App Runner automatic scaling configuration resource.

A higher MinSize increases the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.

A lower MaxSize controls your cost. The tradeoff is lower responsiveness during peak demand.

Multiple revisions of a configuration might have the same AutoScalingConfigurationName and different AutoScalingConfigurationRevision values.

type AutoScalingConfigurationStatus 

type AutoScalingConfigurationStatus string
const (
	AutoScalingConfigurationStatusActive   AutoScalingConfigurationStatus = "ACTIVE"
	AutoScalingConfigurationStatusInactive AutoScalingConfigurationStatus = "INACTIVE"
)

Enum values for AutoScalingConfigurationStatus

func (AutoScalingConfigurationStatus) Values 

func (AutoScalingConfigurationStatus) Values() []AutoScalingConfigurationStatus

Values returns all known values for AutoScalingConfigurationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AutoScalingConfigurationSummary 

type AutoScalingConfigurationSummary struct {

	// The Amazon Resource Name (ARN) of this auto scaling configuration.
	AutoScalingConfigurationArn *string

	// The customer-provided auto scaling configuration name. It can be used in
	// multiple revisions of a configuration.
	AutoScalingConfigurationName *string

	// The revision of this auto scaling configuration. It's unique among all the
	// active configurations ( "Status": "ACTIVE" ) with the same
	// AutoScalingConfigurationName .
	AutoScalingConfigurationRevision int32

	// The time when the auto scaling configuration was created. It's in Unix time
	// stamp format.
	CreatedAt *time.Time

	// Indicates if this auto scaling configuration has an App Runner service
	// associated with it. A value of true indicates one or more services are
	// associated. A value of false indicates no services are associated.
	HasAssociatedService *bool

	// Indicates if this auto scaling configuration should be used as the default for
	// a new App Runner service that does not have an auto scaling configuration ARN
	// specified during creation. Each account can have only one default
	// AutoScalingConfiguration per region. The default AutoScalingConfiguration can
	// be any revision under the same AutoScalingConfigurationName .
	IsDefault *bool

	// The current state of the auto scaling configuration. If the status of a
	// configuration revision is INACTIVE , it was deleted and can't be used. Inactive
	// configuration revisions are permanently removed some time after they are
	// deleted.
	Status AutoScalingConfigurationStatus
	// contains filtered or unexported fields
}

Provides summary information about an App Runner automatic scaling configuration resource.

This type contains limited information about an auto scaling configuration. It includes only identification information, without configuration details. It's returned by the ListAutoScalingConfigurationsaction. Complete configuration information is returned by the CreateAutoScalingConfiguration, DescribeAutoScalingConfiguration , and DeleteAutoScalingConfigurationactions using the AutoScalingConfiguration type.

type CertificateValidationRecord 

type CertificateValidationRecord struct {

	// The certificate CNAME record name.
	Name *string

	// The current state of the certificate CNAME record validation. It should change
	// to SUCCESS after App Runner completes validation with your DNS.
	Status CertificateValidationRecordStatus

	// The record type, always CNAME .
	Type *string

	// The certificate CNAME record value.
	Value *string
	// contains filtered or unexported fields
}

Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.

type CertificateValidationRecordStatus 

type CertificateValidationRecordStatus string
const (
	CertificateValidationRecordStatusPendingValidation CertificateValidationRecordStatus = "PENDING_VALIDATION"
	CertificateValidationRecordStatusSuccess           CertificateValidationRecordStatus = "SUCCESS"
	CertificateValidationRecordStatusFailed            CertificateValidationRecordStatus = "FAILED"
)

Enum values for CertificateValidationRecordStatus

func (CertificateValidationRecordStatus) Values 

func (CertificateValidationRecordStatus) Values() []CertificateValidationRecordStatus

Values returns all known values for CertificateValidationRecordStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CodeConfiguration 

type CodeConfiguration struct {

	// The source of the App Runner configuration. Values are interpreted as follows:
	//
	//   - REPOSITORY – App Runner reads configuration values from the apprunner.yaml
	//   file in the source code repository and ignores CodeConfigurationValues .
	//
	//   - API – App Runner uses configuration values provided in
	//   CodeConfigurationValues and ignores the apprunner.yaml file in the source code
	//   repository.
	//
	// This member is required.
	ConfigurationSource ConfigurationSource

	// The basic configuration for building and running the App Runner service. Use it
	// to quickly launch an App Runner service without providing a apprunner.yaml file
	// in the source code repository (or ignoring the file if it exists).
	CodeConfigurationValues *CodeConfigurationValues
	// contains filtered or unexported fields
}

Describes the configuration that App Runner uses to build and run an App Runner service from a source code repository.

type CodeConfigurationValues 

type CodeConfigurationValues struct {

	// A runtime environment type for building and running an App Runner service. It
	// represents a programming language runtime.
	//
	// This member is required.
	Runtime Runtime

	// The command App Runner runs to build your application.
	BuildCommand *string

	// The port that your application listens to in the container.
	//
	// Default: 8080
	Port *string

	// An array of key-value pairs representing the secrets and parameters that get
	// referenced to your service as an environment variable. The supported values are
	// either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the
	// full ARN of the parameter in the Amazon Web Services Systems Manager Parameter
	// Store.
	//
	//   - If the Amazon Web Services Systems Manager Parameter Store parameter exists
	//   in the same Amazon Web Services Region as the service that you're launching, you
	//   can use either the full ARN or name of the secret. If the parameter exists in a
	//   different Region, then the full ARN must be specified.
	//
	//   - Currently, cross account referencing of Amazon Web Services Systems Manager
	//   Parameter Store parameter is not supported.
	RuntimeEnvironmentSecrets map[string]string

	// The environment variables that are available to your running App Runner
	// service. An array of key-value pairs.
	RuntimeEnvironmentVariables map[string]string

	// The command App Runner runs to start your application.
	StartCommand *string
	// contains filtered or unexported fields
}

Describes the basic configuration needed for building and running an App Runner service. This type doesn't support the full set of possible configuration options. Fur full configuration capabilities, use a apprunner.yaml file in the source code repository.

type CodeRepository 

type CodeRepository struct {

	// The location of the repository that contains the source code.
	//
	// This member is required.
	RepositoryUrl *string

	// The version that should be used within the source code repository.
	//
	// This member is required.
	SourceCodeVersion *SourceCodeVersion

	// Configuration for building and running the service from a source code
	// repository.
	//
	// CodeConfiguration is required only for CreateService request.
	CodeConfiguration *CodeConfiguration

	// The path of the directory that stores source code and configuration files. The
	// build and start commands also execute from here. The path is absolute from root
	// and, if not specified, defaults to the repository root.
	SourceDirectory *string
	// contains filtered or unexported fields
}

Describes a source code repository.

type ConfigurationSource 

type ConfigurationSource string
const (
	ConfigurationSourceRepository ConfigurationSource = "REPOSITORY"
	ConfigurationSourceApi        ConfigurationSource = "API"
)

Enum values for ConfigurationSource

func (ConfigurationSource) Values 

func (ConfigurationSource) Values() []ConfigurationSource

Values returns all known values for ConfigurationSource. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Connection 

type Connection struct {

	// The Amazon Resource Name (ARN) of this connection.
	ConnectionArn *string

	// The customer-provided connection name.
	ConnectionName *string

	// The App Runner connection creation time, expressed as a Unix time stamp.
	CreatedAt *time.Time

	// The source repository provider.
	ProviderType ProviderType

	// The current state of the App Runner connection. When the state is AVAILABLE ,
	// you can use the connection to create an App Runner service.
	Status ConnectionStatus
	// contains filtered or unexported fields
}

Describes an App Runner connection resource.

type ConnectionStatus 

type ConnectionStatus string
const (
	ConnectionStatusPendingHandshake ConnectionStatus = "PENDING_HANDSHAKE"
	ConnectionStatusAvailable        ConnectionStatus = "AVAILABLE"
	ConnectionStatusError            ConnectionStatus = "ERROR"
	ConnectionStatusDeleted          ConnectionStatus = "DELETED"
)

Enum values for ConnectionStatus

func (ConnectionStatus) Values 

func (ConnectionStatus) Values() []ConnectionStatus

Values returns all known values for ConnectionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConnectionSummary 

type ConnectionSummary struct {

	// The Amazon Resource Name (ARN) of this connection.
	ConnectionArn *string

	// The customer-provided connection name.
	ConnectionName *string

	// The App Runner connection creation time, expressed as a Unix time stamp.
	CreatedAt *time.Time

	// The source repository provider.
	ProviderType ProviderType

	// The current state of the App Runner connection. When the state is AVAILABLE ,
	// you can use the connection to create an App Runner service.
	Status ConnectionStatus
	// contains filtered or unexported fields
}

Provides summary information about an App Runner connection resource.

type CustomDomain 

type CustomDomain struct {

	// An associated custom domain endpoint. It can be a root domain (for example,
	// example.com ), a subdomain (for example, login.example.com or
	// admin.login.example.com ), or a wildcard (for example, *.example.com ).
	//
	// This member is required.
	DomainName *string

	// When true , the subdomain www.DomainName  is associated with the App Runner
	// service in addition to the base domain.
	//
	// This member is required.
	EnableWWWSubdomain *bool

	// The current state of the domain name association.
	//
	// This member is required.
	Status CustomDomainAssociationStatus

	// A list of certificate CNAME records that's used for this domain name.
	CertificateValidationRecords []CertificateValidationRecord
	// contains filtered or unexported fields
}

Describes a custom domain that's associated with an App Runner service.

type CustomDomainAssociationStatus 

type CustomDomainAssociationStatus string
const (
	CustomDomainAssociationStatusCreating                        CustomDomainAssociationStatus = "CREATING"
	CustomDomainAssociationStatusCreateFailed                    CustomDomainAssociationStatus = "CREATE_FAILED"
	CustomDomainAssociationStatusActive                          CustomDomainAssociationStatus = "ACTIVE"
	CustomDomainAssociationStatusDeleting                        CustomDomainAssociationStatus = "DELETING"
	CustomDomainAssociationStatusDeleteFailed                    CustomDomainAssociationStatus = "DELETE_FAILED"
	CustomDomainAssociationStatusPendingCertificateDnsValidation CustomDomainAssociationStatus = "PENDING_CERTIFICATE_DNS_VALIDATION"
	CustomDomainAssociationStatusBindingCertificate              CustomDomainAssociationStatus = "BINDING_CERTIFICATE"
)

Enum values for CustomDomainAssociationStatus

func (CustomDomainAssociationStatus) Values 

func (CustomDomainAssociationStatus) Values() []CustomDomainAssociationStatus

Values returns all known values for CustomDomainAssociationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EgressConfiguration 

type EgressConfiguration struct {

	// The type of egress configuration.
	//
	// Set to DEFAULT for access to resources hosted on public networks.
	//
	// Set to VPC to associate your service to a custom VPC specified by
	// VpcConnectorArn .
	EgressType EgressType

	// The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to
	// associate with your App Runner service. Only valid when EgressType = VPC .
	VpcConnectorArn *string
	// contains filtered or unexported fields
}

Describes configuration settings related to outbound network traffic of an App Runner service.

type EgressType 

type EgressType string
const (
	EgressTypeDefault EgressType = "DEFAULT"
	EgressTypeVpc     EgressType = "VPC"
)

Enum values for EgressType

func (EgressType) Values 

func (EgressType) Values() []EgressType

Values returns all known values for EgressType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EncryptionConfiguration 

type EncryptionConfiguration struct {

	// The ARN of the KMS key that's used for encryption.
	//
	// This member is required.
	KmsKey *string
	// contains filtered or unexported fields
}

Describes a custom encryption key that App Runner uses to encrypt copies of the source repository and service logs.

type HealthCheckConfiguration 

type HealthCheckConfiguration struct {

	// The number of consecutive checks that must succeed before App Runner decides
	// that the service is healthy.
	//
	// Default: 1
	HealthyThreshold *int32

	// The time interval, in seconds, between health checks.
	//
	// Default: 5
	Interval *int32

	// The URL that health check requests are sent to.
	//
	// Path is only applicable when you set Protocol to HTTP .
	//
	// Default: "/"
	Path *string

	// The IP protocol that App Runner uses to perform health checks for your service.
	//
	// If you set Protocol to HTTP , App Runner sends health check requests to the HTTP
	// path specified by Path .
	//
	// Default: TCP
	Protocol HealthCheckProtocol

	// The time, in seconds, to wait for a health check response before deciding it
	// failed.
	//
	// Default: 2
	Timeout *int32

	// The number of consecutive checks that must fail before App Runner decides that
	// the service is unhealthy.
	//
	// Default: 5
	UnhealthyThreshold *int32
	// contains filtered or unexported fields
}

Describes the settings for the health check that App Runner performs to monitor the health of a service.

type HealthCheckProtocol 

type HealthCheckProtocol string
const (
	HealthCheckProtocolTcp  HealthCheckProtocol = "TCP"
	HealthCheckProtocolHttp HealthCheckProtocol = "HTTP"
)

Enum values for HealthCheckProtocol

func (HealthCheckProtocol) Values 

func (HealthCheckProtocol) Values() []HealthCheckProtocol

Values returns all known values for HealthCheckProtocol. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ImageConfiguration 

type ImageConfiguration struct {

	// The port that your application listens to in the container.
	//
	// Default: 8080
	Port *string

	// An array of key-value pairs representing the secrets and parameters that get
	// referenced to your service as an environment variable. The supported values are
	// either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the
	// full ARN of the parameter in the Amazon Web Services Systems Manager Parameter
	// Store.
	//
	//   - If the Amazon Web Services Systems Manager Parameter Store parameter exists
	//   in the same Amazon Web Services Region as the service that you're launching, you
	//   can use either the full ARN or name of the secret. If the parameter exists in a
	//   different Region, then the full ARN must be specified.
	//
	//   - Currently, cross account referencing of Amazon Web Services Systems Manager
	//   Parameter Store parameter is not supported.
	RuntimeEnvironmentSecrets map[string]string

	// Environment variables that are available to your running App Runner service. An
	// array of key-value pairs.
	RuntimeEnvironmentVariables map[string]string

	// An optional command that App Runner runs to start the application in the source
	// image. If specified, this command overrides the Docker image’s default start
	// command.
	StartCommand *string
	// contains filtered or unexported fields
}

Describes the configuration that App Runner uses to run an App Runner service using an image pulled from a source image repository.

type ImageRepository 

type ImageRepository struct {

	// The identifier of an image.
	//
	// For an image in Amazon Elastic Container Registry (Amazon ECR), this is an
	// image name. For the image name format, see [Pulling an image]in the Amazon ECR User Guide.
	//
	// [Pulling an image]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html
	//
	// This member is required.
	ImageIdentifier *string

	// The type of the image repository. This reflects the repository provider and
	// whether the repository is private or public.
	//
	// This member is required.
	ImageRepositoryType ImageRepositoryType

	// Configuration for running the identified image.
	ImageConfiguration *ImageConfiguration
	// contains filtered or unexported fields
}

Describes a source image repository.

type ImageRepositoryType 

type ImageRepositoryType string
const (
	ImageRepositoryTypeEcr       ImageRepositoryType = "ECR"
	ImageRepositoryTypeEcrPublic ImageRepositoryType = "ECR_PUBLIC"
)

Enum values for ImageRepositoryType

func (ImageRepositoryType) Values 

func (ImageRepositoryType) Values() []ImageRepositoryType

Values returns all known values for ImageRepositoryType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IngressConfiguration 

type IngressConfiguration struct {

	// Specifies whether your App Runner service is publicly accessible. To make the
	// service publicly accessible set it to True . To make the service privately
	// accessible, from only within an Amazon VPC set it to False .
	IsPubliclyAccessible bool
	// contains filtered or unexported fields
}

Network configuration settings for inbound network traffic.

type IngressVpcConfiguration 

type IngressVpcConfiguration struct {

	// The ID of the VPC endpoint that your App Runner service connects to.
	VpcEndpointId *string

	// The ID of the VPC that is used for the VPC endpoint.
	VpcId *string
	// contains filtered or unexported fields
}

The configuration of your VPC and the associated VPC endpoint. The VPC endpoint is an Amazon Web Services PrivateLink resource that allows access to your App Runner services from within an Amazon VPC.

type InstanceConfiguration 

type InstanceConfiguration struct {

	// The number of CPU units reserved for each instance of your App Runner service.
	//
	// Default: 1 vCPU
	Cpu *string

	// The Amazon Resource Name (ARN) of an IAM role that provides permissions to your
	// App Runner service. These are permissions that your code needs when it calls any
	// Amazon Web Services APIs.
	InstanceRoleArn *string

	// The amount of memory, in MB or GB, reserved for each instance of your App
	// Runner service.
	//
	// Default: 2 GB
	Memory *string
	// contains filtered or unexported fields
}

Describes the runtime configuration of an App Runner service instance (scaling unit).

type InternalServiceErrorException 

type InternalServiceErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An unexpected service exception occurred.

func (*InternalServiceErrorException) Error 

func (e *InternalServiceErrorException) Error() string

func (*InternalServiceErrorException) ErrorCode 

func (e *InternalServiceErrorException) ErrorCode() string

func (*InternalServiceErrorException) ErrorFault 

func (e *InternalServiceErrorException) ErrorFault() smithy.ErrorFault

func (*InternalServiceErrorException) ErrorMessage 

func (e *InternalServiceErrorException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

func (*InvalidRequestException) Error 

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode 

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault 

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage 

func (e *InvalidRequestException) ErrorMessage() string

type InvalidStateException 

type InvalidStateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You can't perform this action when the resource is in its current state.

func (*InvalidStateException) Error 

func (e *InvalidStateException) Error() string

func (*InvalidStateException) ErrorCode 

func (e *InvalidStateException) ErrorCode() string

func (*InvalidStateException) ErrorFault 

func (e *InvalidStateException) ErrorFault() smithy.ErrorFault

func (*InvalidStateException) ErrorMessage 

func (e *InvalidStateException) ErrorMessage() string

type IpAddressType 

type IpAddressType string
const (
	IpAddressTypeIpv4      IpAddressType = "IPV4"
	IpAddressTypeDualStack IpAddressType = "DUAL_STACK"
)

Enum values for IpAddressType

func (IpAddressType) Values 

func (IpAddressType) Values() []IpAddressType

Values returns all known values for IpAddressType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ListVpcIngressConnectionsFilter 

type ListVpcIngressConnectionsFilter struct {

	// The Amazon Resource Name (ARN) of a service to filter by.
	ServiceArn *string

	// The ID of a VPC Endpoint to filter by.
	VpcEndpointId *string
	// contains filtered or unexported fields
}

Returns a list of VPC Ingress Connections based on the filter provided. It can return either ServiceArn or VpcEndpointId , or both.

type NetworkConfiguration 

type NetworkConfiguration struct {

	// Network configuration settings for outbound message traffic.
	EgressConfiguration *EgressConfiguration

	// Network configuration settings for inbound message traffic.
	IngressConfiguration *IngressConfiguration

	// App Runner provides you with the option to choose between Internet Protocol
	// version 4 (IPv4) and dual stack (IPv4 and IPv6) for your incoming public network
	// configuration. This is an optional parameter. If you do not specify an
	// IpAddressType , it defaults to select IPv4.
	//
	// Currently, App Runner supports dual stack for only Public endpoint. Only IPv4
	// is supported for Private endpoint. If you update a service that's using
	// dual-stack Public endpoint to a Private endpoint, your App Runner service will
	// default to support only IPv4 for Private endpoint and fail to receive traffic
	// originating from IPv6 endpoint.
	IpAddressType IpAddressType
	// contains filtered or unexported fields
}

Describes configuration settings related to network traffic of an App Runner service. Consists of embedded objects for each configurable network feature.

type ObservabilityConfiguration 

type ObservabilityConfiguration struct {

	// The time when the observability configuration was created. It's in Unix time
	// stamp format.
	CreatedAt *time.Time

	// The time when the observability configuration was deleted. It's in Unix time
	// stamp format.
	DeletedAt *time.Time

	// It's set to true for the configuration with the highest Revision among all
	// configurations that share the same ObservabilityConfigurationName . It's set to
	// false otherwise.
	Latest bool

	// The Amazon Resource Name (ARN) of this observability configuration.
	ObservabilityConfigurationArn *string

	// The customer-provided observability configuration name. It can be used in
	// multiple revisions of a configuration.
	ObservabilityConfigurationName *string

	// The revision of this observability configuration. It's unique among all the
	// active configurations ( "Status": "ACTIVE" ) that share the same
	// ObservabilityConfigurationName .
	ObservabilityConfigurationRevision int32

	// The current state of the observability configuration. If the status of a
	// configuration revision is INACTIVE , it was deleted and can't be used. Inactive
	// configuration revisions are permanently removed some time after they are
	// deleted.
	Status ObservabilityConfigurationStatus

	// The configuration of the tracing feature within this observability
	// configuration. If not specified, tracing isn't enabled.
	TraceConfiguration *TraceConfiguration
	// contains filtered or unexported fields
}

Describes an App Runner observability configuration resource. Multiple revisions of a configuration have the same ObservabilityConfigurationName and different ObservabilityConfigurationRevision values.

The resource is designed to configure multiple features (currently one feature, tracing). This type contains optional members that describe the configuration of these features (currently one member, TraceConfiguration ). If a feature member isn't specified, the feature isn't enabled.

type ObservabilityConfigurationStatus 

type ObservabilityConfigurationStatus string
const (
	ObservabilityConfigurationStatusActive   ObservabilityConfigurationStatus = "ACTIVE"
	ObservabilityConfigurationStatusInactive ObservabilityConfigurationStatus = "INACTIVE"
)

Enum values for ObservabilityConfigurationStatus

func (ObservabilityConfigurationStatus) Values 

func (ObservabilityConfigurationStatus) Values() []ObservabilityConfigurationStatus

Values returns all known values for ObservabilityConfigurationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ObservabilityConfigurationSummary 

type ObservabilityConfigurationSummary struct {

	// The Amazon Resource Name (ARN) of this observability configuration.
	ObservabilityConfigurationArn *string

	// The customer-provided observability configuration name. It can be used in
	// multiple revisions of a configuration.
	ObservabilityConfigurationName *string

	// The revision of this observability configuration. It's unique among all the
	// active configurations ( "Status": "ACTIVE" ) that share the same
	// ObservabilityConfigurationName .
	ObservabilityConfigurationRevision int32
	// contains filtered or unexported fields
}

Provides summary information about an App Runner observability configuration resource.

This type contains limited information about an observability configuration. It includes only identification information, without configuration details. It's returned by the ListObservabilityConfigurationsaction. Complete configuration information is returned by the CreateObservabilityConfiguration, DescribeObservabilityConfiguration , and DeleteObservabilityConfigurationactions using the ObservabilityConfiguration type.

type OperationStatus 

type OperationStatus string
const (
	OperationStatusPending            OperationStatus = "PENDING"
	OperationStatusInProgress         OperationStatus = "IN_PROGRESS"
	OperationStatusFailed             OperationStatus = "FAILED"
	OperationStatusSucceeded          OperationStatus = "SUCCEEDED"
	OperationStatusRollbackInProgress OperationStatus = "ROLLBACK_IN_PROGRESS"
	OperationStatusRollbackFailed     OperationStatus = "ROLLBACK_FAILED"
	OperationStatusRollbackSucceeded  OperationStatus = "ROLLBACK_SUCCEEDED"
)

Enum values for OperationStatus

func (OperationStatus) Values 

func (OperationStatus) Values() []OperationStatus

Values returns all known values for OperationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OperationSummary 

type OperationSummary struct {

	// The time when the operation ended. It's in the Unix time stamp format.
	EndedAt *time.Time

	// A unique ID of this operation. It's unique in the scope of the App Runner
	// service.
	Id *string

	// The time when the operation started. It's in the Unix time stamp format.
	StartedAt *time.Time

	// The current state of the operation.
	Status OperationStatus

	// The Amazon Resource Name (ARN) of the resource that the operation acted on (for
	// example, an App Runner service).
	TargetArn *string

	// The type of operation. It indicates a specific action that occured.
	Type OperationType

	// The time when the operation was last updated. It's in the Unix time stamp
	// format.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Provides summary information for an operation that occurred on an App Runner service.

type OperationType 

type OperationType string
const (
	OperationTypeStartDeployment OperationType = "START_DEPLOYMENT"
	OperationTypeCreateService   OperationType = "CREATE_SERVICE"
	OperationTypePauseService    OperationType = "PAUSE_SERVICE"
	OperationTypeResumeService   OperationType = "RESUME_SERVICE"
	OperationTypeDeleteService   OperationType = "DELETE_SERVICE"
	OperationTypeUpdateService   OperationType = "UPDATE_SERVICE"
)

Enum values for OperationType

func (OperationType) Values 

func (OperationType) Values() []OperationType

Values returns all known values for OperationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProviderType 

type ProviderType string
const (
	ProviderTypeGithub    ProviderType = "GITHUB"
	ProviderTypeBitbucket ProviderType = "BITBUCKET"
)

Enum values for ProviderType

func (ProviderType) Values 

func (ProviderType) Values() []ProviderType

Values returns all known values for ProviderType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type Runtime 

type Runtime string
const (
	RuntimePython3    Runtime = "PYTHON_3"
	RuntimeNodejs12   Runtime = "NODEJS_12"
	RuntimeNodejs14   Runtime = "NODEJS_14"
	RuntimeCorretto8  Runtime = "CORRETTO_8"
	RuntimeCorretto11 Runtime = "CORRETTO_11"
	RuntimeNodejs16   Runtime = "NODEJS_16"
	RuntimeGo1        Runtime = "GO_1"
	RuntimeDotnet6    Runtime = "DOTNET_6"
	RuntimePhp81      Runtime = "PHP_81"
	RuntimeRuby31     Runtime = "RUBY_31"
	RuntimePython311  Runtime = "PYTHON_311"
	RuntimeNodejs18   Runtime = "NODEJS_18"
)

Enum values for Runtime

func (Runtime) Values 

func (Runtime) Values() []Runtime

Values returns all known values for Runtime. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Service 

type Service struct {

	// Summary information for the App Runner automatic scaling configuration resource
	// that's associated with this service.
	//
	// This member is required.
	AutoScalingConfigurationSummary *AutoScalingConfigurationSummary

	// The time when the App Runner service was created. It's in the Unix time stamp
	// format.
	//
	// This member is required.
	CreatedAt *time.Time

	// The runtime configuration of instances (scaling units) of this service.
	//
	// This member is required.
	InstanceConfiguration *InstanceConfiguration

	// Configuration settings related to network traffic of the web application that
	// this service runs.
	//
	// This member is required.
	NetworkConfiguration *NetworkConfiguration

	// The Amazon Resource Name (ARN) of this service.
	//
	// This member is required.
	ServiceArn *string

	// An ID that App Runner generated for this service. It's unique within the Amazon
	// Web Services Region.
	//
	// This member is required.
	ServiceId *string

	// The customer-provided service name.
	//
	// This member is required.
	ServiceName *string

	// The source deployed to the App Runner service. It can be a code or an image
	// repository.
	//
	// This member is required.
	SourceConfiguration *SourceConfiguration

	// The current state of the App Runner service. These particular values mean the
	// following.
	//
	//   - CREATE_FAILED – The service failed to create. The failed service isn't
	//   usable, and still counts towards your service quota. To troubleshoot this
	//   failure, read the failure events and logs, change any parameters that need to be
	//   fixed, and rebuild your service using UpdateService .
	//
	//   - DELETE_FAILED – The service failed to delete and can't be successfully
	//   recovered. Retry the service deletion call to ensure that all related resources
	//   are removed.
	//
	// This member is required.
	Status ServiceStatus

	// The time when the App Runner service was last updated at. It's in the Unix time
	// stamp format.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The time when the App Runner service was deleted. It's in the Unix time stamp
	// format.
	DeletedAt *time.Time

	// The encryption key that App Runner uses to encrypt the service logs and the
	// copy of the source repository that App Runner maintains for the service. It can
	// be either a customer-provided encryption key or an Amazon Web Services managed
	// key.
	EncryptionConfiguration *EncryptionConfiguration

	// The settings for the health check that App Runner performs to monitor the
	// health of this service.
	HealthCheckConfiguration *HealthCheckConfiguration

	// The observability configuration of this service.
	ObservabilityConfiguration *ServiceObservabilityConfiguration

	// A subdomain URL that App Runner generated for this service. You can use this
	// URL to access your service web application.
	ServiceUrl *string
	// contains filtered or unexported fields
}

Describes an App Runner service. It can describe a service in any state, including deleted services.

This type contains the full information about a service, including configuration details. It's returned by the CreateService, DescribeService, and DeleteService actions. A subset of this information is returned by the ListServicesaction using the ServiceSummary type.

type ServiceObservabilityConfiguration 

type ServiceObservabilityConfiguration struct {

	// When true , an observability configuration resource is associated with the
	// service, and an ObservabilityConfigurationArn is specified.
	//
	// This member is required.
	ObservabilityEnabled bool

	// The Amazon Resource Name (ARN) of the observability configuration that is
	// associated with the service. Specified only when ObservabilityEnabled is true .
	//
	// Specify an ARN with a name and a revision number to associate that revision.
	// For example:
	// arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
	//
	// Specify just the name to associate the latest revision. For example:
	// arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
	ObservabilityConfigurationArn *string
	// contains filtered or unexported fields
}

Describes the observability configuration of an App Runner service. These are additional observability features, like tracing, that you choose to enable. They're configured in a separate resource that you associate with your service.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

App Runner can't create this resource. You've reached your account quota for this resource type.

For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ServiceStatus 

type ServiceStatus string
const (
	ServiceStatusCreateFailed        ServiceStatus = "CREATE_FAILED"
	ServiceStatusRunning             ServiceStatus = "RUNNING"
	ServiceStatusDeleted             ServiceStatus = "DELETED"
	ServiceStatusDeleteFailed        ServiceStatus = "DELETE_FAILED"
	ServiceStatusPaused              ServiceStatus = "PAUSED"
	ServiceStatusOperationInProgress ServiceStatus = "OPERATION_IN_PROGRESS"
)

Enum values for ServiceStatus

func (ServiceStatus) Values 

func (ServiceStatus) Values() []ServiceStatus

Values returns all known values for ServiceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceSummary 

type ServiceSummary struct {

	// The time when the App Runner service was created. It's in the Unix time stamp
	// format.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of this service.
	ServiceArn *string

	// An ID that App Runner generated for this service. It's unique within the Amazon
	// Web Services Region.
	ServiceId *string

	// The customer-provided service name.
	ServiceName *string

	// A subdomain URL that App Runner generated for this service. You can use this
	// URL to access your service web application.
	ServiceUrl *string

	// The current state of the App Runner service. These particular values mean the
	// following.
	//
	//   - CREATE_FAILED – The service failed to create. The failed service isn't
	//   usable, and still counts towards your service quota. To troubleshoot this
	//   failure, read the failure events and logs, change any parameters that need to be
	//   fixed, and rebuild your service using UpdateService .
	//
	//   - DELETE_FAILED – The service failed to delete and can't be successfully
	//   recovered. Retry the service deletion call to ensure that all related resources
	//   are removed.
	Status ServiceStatus

	// The time when the App Runner service was last updated. It's in theUnix time
	// stamp format.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Provides summary information for an App Runner service.

This type contains limited information about a service. It doesn't include configuration details. It's returned by the ListServicesaction. Complete service information is returned by the CreateService, DescribeService, and DeleteService actions using the Service type.

type SourceCodeVersion 

type SourceCodeVersion struct {

	// The type of version identifier.
	//
	// For a git-based repository, branches represent versions.
	//
	// This member is required.
	Type SourceCodeVersionType

	// A source code version.
	//
	// For a git-based repository, a branch name maps to a specific version. App
	// Runner uses the most recent commit to the branch.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Identifies a version of code that App Runner refers to within a source code repository.

type SourceCodeVersionType 

type SourceCodeVersionType string
const (
	SourceCodeVersionTypeBranch SourceCodeVersionType = "BRANCH"
)

Enum values for SourceCodeVersionType

func (SourceCodeVersionType) Values 

func (SourceCodeVersionType) Values() []SourceCodeVersionType

Values returns all known values for SourceCodeVersionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SourceConfiguration 

type SourceConfiguration struct {

	// Describes the resources that are needed to authenticate access to some source
	// repositories.
	AuthenticationConfiguration *AuthenticationConfiguration

	// If true , continuous integration from the source repository is enabled for the
	// App Runner service. Each repository change (including any source code commit or
	// new image version) starts a deployment.
	//
	// Default: App Runner sets to false for a source image that uses an ECR Public
	// repository or an ECR repository that's in an Amazon Web Services account other
	// than the one that the service is in. App Runner sets to true in all other cases
	// (which currently include a source code repository or a source image using a
	// same-account ECR repository).
	AutoDeploymentsEnabled *bool

	// The description of a source code repository.
	//
	// You must provide either this member or ImageRepository (but not both).
	CodeRepository *CodeRepository

	// The description of a source image repository.
	//
	// You must provide either this member or CodeRepository (but not both).
	ImageRepository *ImageRepository
	// contains filtered or unexported fields
}

Describes the source deployed to an App Runner service. It can be a code or an image repository.

type Tag 

type Tag struct {

	// The key of the tag.
	Key *string

	// The value of the tag.
	Value *string
	// contains filtered or unexported fields
}

Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.

type TraceConfiguration 

type TraceConfiguration struct {

	// The implementation provider chosen for tracing App Runner services.
	//
	// This member is required.
	Vendor TracingVendor
	// contains filtered or unexported fields
}

Describes the configuration of the tracing feature within an App Runner observability configuration.

type TracingVendor 

type TracingVendor string
const (
	TracingVendorAwsxray TracingVendor = "AWSXRAY"
)

Enum values for TracingVendor

func (TracingVendor) Values 

func (TracingVendor) Values() []TracingVendor

Values returns all known values for TracingVendor. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VpcConnector 

type VpcConnector struct {

	// The time when the VPC connector was created. It's in Unix time stamp format.
	CreatedAt *time.Time

	// The time when the VPC connector was deleted. It's in Unix time stamp format.
	DeletedAt *time.Time

	// A list of IDs of security groups that App Runner uses for access to Amazon Web
	// Services resources under the specified subnets. If not specified, App Runner
	// uses the default security group of the Amazon VPC. The default security group
	// allows all outbound traffic.
	SecurityGroups []string

	// The current state of the VPC connector. If the status of a connector revision
	// is INACTIVE , it was deleted and can't be used. Inactive connector revisions are
	// permanently removed some time after they are deleted.
	Status VpcConnectorStatus

	// A list of IDs of subnets that App Runner uses for your service. All IDs are of
	// subnets of a single Amazon VPC.
	Subnets []string

	// The Amazon Resource Name (ARN) of this VPC connector.
	VpcConnectorArn *string

	// The customer-provided VPC connector name.
	VpcConnectorName *string

	// The revision of this VPC connector. It's unique among all the active connectors
	// ( "Status": "ACTIVE" ) that share the same Name .
	//
	// At this time, App Runner supports only one revision per name.
	VpcConnectorRevision int32
	// contains filtered or unexported fields
}

Describes an App Runner VPC connector resource. A VPC connector describes the Amazon Virtual Private Cloud (Amazon VPC) that an App Runner service is associated with, and the subnets and security group that are used.

Multiple revisions of a connector might have the same Name and different Revision values.

At this time, App Runner supports only one revision per name.

type VpcConnectorStatus 

type VpcConnectorStatus string
const (
	VpcConnectorStatusActive   VpcConnectorStatus = "ACTIVE"
	VpcConnectorStatusInactive VpcConnectorStatus = "INACTIVE"
)

Enum values for VpcConnectorStatus

func (VpcConnectorStatus) Values 

func (VpcConnectorStatus) Values() []VpcConnectorStatus

Values returns all known values for VpcConnectorStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VpcDNSTarget 

type VpcDNSTarget struct {

	// The domain name of your target DNS that is associated with the Amazon VPC.
	DomainName *string

	// The ID of the Amazon VPC that is associated with the custom domain name of the
	// target DNS.
	VpcId *string

	// The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated
	// with your service.
	VpcIngressConnectionArn *string
	// contains filtered or unexported fields
}

DNS Target record for a custom domain of this Amazon VPC.

type VpcIngressConnection 

type VpcIngressConnection struct {

	// The Account Id you use to create the VPC Ingress Connection resource.
	AccountId *string

	// The time when the VPC Ingress Connection was created. It's in the Unix time
	// stamp format.
	//
	//   - Type: Timestamp
	//
	//   - Required: Yes
	CreatedAt *time.Time

	// The time when the App Runner service was deleted. It's in the Unix time stamp
	// format.
	//
	//   - Type: Timestamp
	//
	//   - Required: No
	DeletedAt *time.Time

	// The domain name associated with the VPC Ingress Connection resource.
	DomainName *string

	// Specifications for the customer’s VPC and related PrivateLink VPC endpoint that
	// are used to associate with the VPC Ingress Connection resource.
	IngressVpcConfiguration *IngressVpcConfiguration

	// The Amazon Resource Name (ARN) of the service associated with the VPC Ingress
	// Connection.
	ServiceArn *string

	// The current status of the VPC Ingress Connection. The VPC Ingress Connection
	// displays one of the following statuses: AVAILABLE , PENDING_CREATION ,
	// PENDING_UPDATE , PENDING_DELETION , FAILED_CREATION , FAILED_UPDATE ,
	// FAILED_DELETION , and DELETED ..
	Status VpcIngressConnectionStatus

	// The Amazon Resource Name (ARN) of the VPC Ingress Connection.
	VpcIngressConnectionArn *string

	// The customer-provided VPC Ingress Connection name.
	VpcIngressConnectionName *string
	// contains filtered or unexported fields
}

The App Runner resource that specifies an App Runner endpoint for incoming traffic. It establishes a connection between a VPC interface endpoint and a App Runner service, to make your App Runner service accessible from only within an Amazon VPC.

type VpcIngressConnectionStatus 

type VpcIngressConnectionStatus string
const (
	VpcIngressConnectionStatusAvailable       VpcIngressConnectionStatus = "AVAILABLE"
	VpcIngressConnectionStatusPendingCreation VpcIngressConnectionStatus = "PENDING_CREATION"
	VpcIngressConnectionStatusPendingUpdate   VpcIngressConnectionStatus = "PENDING_UPDATE"
	VpcIngressConnectionStatusPendingDeletion VpcIngressConnectionStatus = "PENDING_DELETION"
	VpcIngressConnectionStatusFailedCreation  VpcIngressConnectionStatus = "FAILED_CREATION"
	VpcIngressConnectionStatusFailedUpdate    VpcIngressConnectionStatus = "FAILED_UPDATE"
	VpcIngressConnectionStatusFailedDeletion  VpcIngressConnectionStatus = "FAILED_DELETION"
	VpcIngressConnectionStatusDeleted         VpcIngressConnectionStatus = "DELETED"
)

Enum values for VpcIngressConnectionStatus

func (VpcIngressConnectionStatus) Values 

func (VpcIngressConnectionStatus) Values() []VpcIngressConnectionStatus

Values returns all known values for VpcIngressConnectionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VpcIngressConnectionSummary 

type VpcIngressConnectionSummary struct {

	// The Amazon Resource Name (ARN) of the service associated with the VPC Ingress
	// Connection.
	ServiceArn *string

	// The Amazon Resource Name (ARN) of the VPC Ingress Connection.
	VpcIngressConnectionArn *string
	// contains filtered or unexported fields
}

Provides summary information about an VPC Ingress Connection, which includes its VPC Ingress Connection ARN and its associated Service ARN.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.