Documentation ¶
Overview ¶
Package apprunner provides the API client, operations, and parameter types for AWS App Runner.
AWS App Runner AWS App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code to a running service in the AWS cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and configure AWS resources. App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, high performance, scalability, and security. For more information about App Runner, see the AWS App Runner Developer Guide (https://docs.aws.amazon.com/apprunner/latest/dg/). For release information, see the AWS App Runner Release Notes (https://docs.aws.amazon.com/apprunner/latest/relnotes/). To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for Amazon Web Services (http://aws.amazon.com/tools/). Endpoints For a list of Region-specific endpoints that App Runner supports, see AWS App Runner endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/apprunner.html) in the AWS General Reference.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type AssociateCustomDomainInput
- type AssociateCustomDomainOutput
- type Client
- func (c *Client) AssociateCustomDomain(ctx context.Context, params *AssociateCustomDomainInput, ...) (*AssociateCustomDomainOutput, error)
- func (c *Client) CreateAutoScalingConfiguration(ctx context.Context, params *CreateAutoScalingConfigurationInput, ...) (*CreateAutoScalingConfigurationOutput, error)
- func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionInput, optFns ...func(*Options)) (*CreateConnectionOutput, error)
- func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error)
- func (c *Client) DeleteAutoScalingConfiguration(ctx context.Context, params *DeleteAutoScalingConfigurationInput, ...) (*DeleteAutoScalingConfigurationOutput, error)
- func (c *Client) DeleteConnection(ctx context.Context, params *DeleteConnectionInput, optFns ...func(*Options)) (*DeleteConnectionOutput, error)
- func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, optFns ...func(*Options)) (*DeleteServiceOutput, error)
- func (c *Client) DescribeAutoScalingConfiguration(ctx context.Context, params *DescribeAutoScalingConfigurationInput, ...) (*DescribeAutoScalingConfigurationOutput, error)
- func (c *Client) DescribeCustomDomains(ctx context.Context, params *DescribeCustomDomainsInput, ...) (*DescribeCustomDomainsOutput, error)
- func (c *Client) DescribeService(ctx context.Context, params *DescribeServiceInput, optFns ...func(*Options)) (*DescribeServiceOutput, error)
- func (c *Client) DisassociateCustomDomain(ctx context.Context, params *DisassociateCustomDomainInput, ...) (*DisassociateCustomDomainOutput, error)
- func (c *Client) ListAutoScalingConfigurations(ctx context.Context, params *ListAutoScalingConfigurationsInput, ...) (*ListAutoScalingConfigurationsOutput, error)
- func (c *Client) ListConnections(ctx context.Context, params *ListConnectionsInput, optFns ...func(*Options)) (*ListConnectionsOutput, error)
- func (c *Client) ListOperations(ctx context.Context, params *ListOperationsInput, optFns ...func(*Options)) (*ListOperationsOutput, error)
- func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, optFns ...func(*Options)) (*ListServicesOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) PauseService(ctx context.Context, params *PauseServiceInput, optFns ...func(*Options)) (*PauseServiceOutput, error)
- func (c *Client) ResumeService(ctx context.Context, params *ResumeServiceInput, optFns ...func(*Options)) (*ResumeServiceOutput, error)
- func (c *Client) StartDeployment(ctx context.Context, params *StartDeploymentInput, optFns ...func(*Options)) (*StartDeploymentOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error)
- type CreateAutoScalingConfigurationInput
- type CreateAutoScalingConfigurationOutput
- type CreateConnectionInput
- type CreateConnectionOutput
- type CreateServiceInput
- type CreateServiceOutput
- type DeleteAutoScalingConfigurationInput
- type DeleteAutoScalingConfigurationOutput
- type DeleteConnectionInput
- type DeleteConnectionOutput
- type DeleteServiceInput
- type DeleteServiceOutput
- type DescribeAutoScalingConfigurationInput
- type DescribeAutoScalingConfigurationOutput
- type DescribeCustomDomainsAPIClient
- type DescribeCustomDomainsInput
- type DescribeCustomDomainsOutput
- type DescribeCustomDomainsPaginator
- type DescribeCustomDomainsPaginatorOptions
- type DescribeServiceInput
- type DescribeServiceOutput
- type DisassociateCustomDomainInput
- type DisassociateCustomDomainOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type HTTPClient
- type HTTPSignerV4
- type ListAutoScalingConfigurationsAPIClient
- type ListAutoScalingConfigurationsInput
- type ListAutoScalingConfigurationsOutput
- type ListAutoScalingConfigurationsPaginator
- type ListAutoScalingConfigurationsPaginatorOptions
- type ListConnectionsAPIClient
- type ListConnectionsInput
- type ListConnectionsOutput
- type ListConnectionsPaginator
- type ListConnectionsPaginatorOptions
- type ListOperationsAPIClient
- type ListOperationsInput
- type ListOperationsOutput
- type ListOperationsPaginator
- type ListOperationsPaginatorOptions
- type ListServicesAPIClient
- type ListServicesInput
- type ListServicesOutput
- type ListServicesPaginator
- type ListServicesPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type PauseServiceInput
- type PauseServiceOutput
- type ResolveEndpoint
- type ResumeServiceInput
- type ResumeServiceOutput
- type StartDeploymentInput
- type StartDeploymentOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateServiceInput
- type UpdateServiceOutput
Constants ¶
const ServiceAPIVersion = "2020-05-15"
const ServiceID = "AppRunner"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type AssociateCustomDomainInput ¶
type AssociateCustomDomainInput struct { // A custom domain endpoint to associate. Specify 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 // The Amazon Resource Name (ARN) of the App Runner service that you want to // associate a custom domain name with. // // This member is required. ServiceArn *string // Set to true to associate the subdomain www.DomainName with the App Runner // service in addition to the base domain. Default: true EnableWWWSubdomain *bool }
type AssociateCustomDomainOutput ¶
type AssociateCustomDomainOutput struct { // A description of the domain name that's being associated. // // This member is required. CustomDomain *types.CustomDomain // The App Runner subdomain of the App Runner service. The custom domain name is // mapped to this target name. // // This member is required. DNSTarget *string // The Amazon Resource Name (ARN) of the App Runner service with which a custom // domain name is associated. // // This member is required. ServiceArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS App Runner.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateCustomDomain ¶
func (c *Client) AssociateCustomDomain(ctx context.Context, params *AssociateCustomDomainInput, optFns ...func(*Options)) (*AssociateCustomDomainOutput, error)
Associate your own domain name with the AWS App Runner subdomain URL of your App Runner service. After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks domain validity in a certificate stored in AWS Certificate Manager (ACM) (https://docs.aws.amazon.com/acm/latest/userguide).
func (*Client) CreateAutoScalingConfiguration ¶
func (c *Client) CreateAutoScalingConfiguration(ctx context.Context, params *CreateAutoScalingConfigurationInput, optFns ...func(*Options)) (*CreateAutoScalingConfigurationOutput, error)
Create an AWS App Runner automatic scaling configuration resource. App Runner requires this resource when you create App Runner services that require non-default auto scaling settings. You can share an auto scaling configuration across multiple services. Create multiple revisions of a configuration by using the same AutoScalingConfigurationName and different AutoScalingConfigurationRevision values. When you create a service, you can set it to use the latest active revision of an auto scaling configuration or a specific revision. Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the AWS Region. The tradeoff is a higher minimal cost. Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.
func (*Client) CreateConnection ¶
func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionInput, optFns ...func(*Options)) (*CreateConnectionOutput, error)
Create an AWS App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services. A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection.
func (*Client) CreateService ¶
func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error)
Create an AWS App Runner service. After the service is created, the action also automatically starts a deployment. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations (https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html) call to track the operation's progress.
func (*Client) DeleteAutoScalingConfiguration ¶
func (c *Client) DeleteAutoScalingConfiguration(ctx context.Context, params *DeleteAutoScalingConfigurationInput, optFns ...func(*Options)) (*DeleteAutoScalingConfigurationOutput, error)
Delete an AWS App Runner automatic scaling configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services.
func (*Client) DeleteConnection ¶
func (c *Client) DeleteConnection(ctx context.Context, params *DeleteConnectionInput, optFns ...func(*Options)) (*DeleteConnectionOutput, error)
Delete an AWS App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the DeleteConnection action fails.
func (*Client) DeleteService ¶
func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, optFns ...func(*Options)) (*DeleteServiceOutput, error)
Delete an AWS App Runner service. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
func (*Client) DescribeAutoScalingConfiguration ¶
func (c *Client) DescribeAutoScalingConfiguration(ctx context.Context, params *DescribeAutoScalingConfigurationInput, optFns ...func(*Options)) (*DescribeAutoScalingConfigurationOutput, error)
Return a full description of an AWS App Runner automatic scaling configuration resource.
func (*Client) DescribeCustomDomains ¶
func (c *Client) DescribeCustomDomains(ctx context.Context, params *DescribeCustomDomainsInput, optFns ...func(*Options)) (*DescribeCustomDomainsOutput, error)
Return a description of custom domain names that are associated with an AWS App Runner service.
func (*Client) DescribeService ¶
func (c *Client) DescribeService(ctx context.Context, params *DescribeServiceInput, optFns ...func(*Options)) (*DescribeServiceOutput, error)
Return a full description of an AWS App Runner service.
func (*Client) DisassociateCustomDomain ¶
func (c *Client) DisassociateCustomDomain(ctx context.Context, params *DisassociateCustomDomainInput, optFns ...func(*Options)) (*DisassociateCustomDomainOutput, error)
Disassociate a custom domain name from an AWS App Runner service. Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM) (https://docs.aws.amazon.com/acm/latest/userguide). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.
func (*Client) ListAutoScalingConfigurations ¶
func (c *Client) ListAutoScalingConfigurations(ctx context.Context, params *ListAutoScalingConfigurationsInput, optFns ...func(*Options)) (*ListAutoScalingConfigurationsOutput, error)
Returns a list of AWS App Runner automatic scaling configurations in your AWS account. You can query the revisions for a specific configuration name or the revisions for all configurations in your account. You can optionally query only the latest revision of each requested name.
func (*Client) ListConnections ¶
func (c *Client) ListConnections(ctx context.Context, params *ListConnectionsInput, optFns ...func(*Options)) (*ListConnectionsOutput, error)
Returns a list of AWS App Runner connections that are associated with your AWS account.
func (*Client) ListOperations ¶
func (c *Client) ListOperations(ctx context.Context, params *ListOperationsInput, optFns ...func(*Options)) (*ListOperationsOutput, error)
Return a list of operations that occurred on an AWS App Runner service. The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the last started operation.
func (*Client) ListServices ¶
func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, optFns ...func(*Options)) (*ListServicesOutput, error)
Returns a list of running AWS App Runner services in your AWS account.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
List tags that are associated with for an AWS App Runner resource. The response contains a list of tag key-value pairs.
func (*Client) PauseService ¶
func (c *Client) PauseService(ctx context.Context, params *PauseServiceInput, optFns ...func(*Options)) (*PauseServiceOutput, error)
Pause an active AWS App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed). This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
func (*Client) ResumeService ¶
func (c *Client) ResumeService(ctx context.Context, params *ResumeServiceInput, optFns ...func(*Options)) (*ResumeServiceOutput, error)
Resume an active AWS App Runner service. App Runner provisions compute capacity for the service. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
func (*Client) StartDeployment ¶
func (c *Client) StartDeployment(ctx context.Context, params *StartDeploymentInput, optFns ...func(*Options)) (*StartDeploymentOutput, error)
Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an AWS App Runner service. For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Remove tags from an App Runner resource.
func (*Client) UpdateService ¶
func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error)
Update an AWS App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service. To update the tags applied to your service, use the separate actions TagResource and UntagResource. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
type CreateAutoScalingConfigurationInput ¶
type CreateAutoScalingConfigurationInput struct { // A name for the auto scaling configuration. When you use it for the first time in // an AWS Region, App Runner creates revision number 1 of this name. When you use // the same name in subsequent calls, App Runner creates incremental revisions of // the configuration. // // This member is required. AutoScalingConfigurationName *string // The maximum number of concurrent requests that you want an instance to process. // If the number of concurrent requests exceeds this limit, App Runner scales up // your service. Default: 100 MaxConcurrency *int32 // The maximum number of instances that your service scales up to. At most MaxSize // instances actively serve traffic for your service. Default: 25 MaxSize *int32 // The minimum number of instances that App Runner provisions for your 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. Default: 1 MinSize *int32 // A list of metadata items that you can associate with your auto scaling // configuration resource. A tag is a key-value pair. Tags []types.Tag }
type CreateAutoScalingConfigurationOutput ¶
type CreateAutoScalingConfigurationOutput struct { // A description of the App Runner auto scaling configuration that's created by // this request. // // This member is required. AutoScalingConfiguration *types.AutoScalingConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateConnectionInput ¶
type CreateConnectionInput struct { // A name for the new connection. It must be unique across all App Runner // connections for the AWS account in the AWS Region. // // This member is required. ConnectionName *string // The source repository provider. // // This member is required. ProviderType types.ProviderType // A list of metadata items that you can associate with your connection resource. A // tag is a key-value pair. Tags []types.Tag }
type CreateConnectionOutput ¶
type CreateConnectionOutput struct { // A description of the App Runner connection that's created by this request. // // This member is required. Connection *types.Connection // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateServiceInput ¶
type CreateServiceInput struct { // A name for the new service. It must be unique across all the running App Runner // services in your AWS account in the AWS Region. // // This member is required. ServiceName *string // The source to deploy to the App Runner service. It can be a code or an image // repository. // // This member is required. SourceConfiguration *types.SourceConfiguration // The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration // resource that you want to associate with your service. If not provided, App // Runner associates the latest revision of a default auto scaling configuration. AutoScalingConfigurationArn *string // An optional custom encryption key that App Runner uses to encrypt the copy of // your source repository that it maintains and your service logs. By default, App // Runner uses an AWS managed CMK. EncryptionConfiguration *types.EncryptionConfiguration // The settings for the health check that AWS App Runner performs to monitor the // health of your service. HealthCheckConfiguration *types.HealthCheckConfiguration // The runtime configuration of instances (scaling units) of the App Runner // service. InstanceConfiguration *types.InstanceConfiguration // An optional list of metadata items that you can associate with your service // resource. A tag is a key-value pair. Tags []types.Tag }
type CreateServiceOutput ¶
type CreateServiceOutput struct { // The unique ID of the asynchronous operation that this request started. You can // use it combined with the ListOperations // (https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html) call // to track the operation's progress. // // This member is required. OperationId *string // A description of the App Runner service that's created by this request. // // This member is required. Service *types.Service // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAutoScalingConfigurationInput ¶
type DeleteAutoScalingConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that // you want to delete. The ARN can be a full auto scaling configuration ARN, or a // partial ARN ending with either .../name or .../name/revision . If a revision // isn't specified, the latest active revision is deleted. // // This member is required. AutoScalingConfigurationArn *string }
type DeleteAutoScalingConfigurationOutput ¶
type DeleteAutoScalingConfigurationOutput struct { // A description of the App Runner auto scaling configuration that this request // just deleted. // // This member is required. AutoScalingConfiguration *types.AutoScalingConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteConnectionInput ¶
type DeleteConnectionInput struct { // The Amazon Resource Name (ARN) of the App Runner connection that you want to // delete. // // This member is required. ConnectionArn *string }
type DeleteConnectionOutput ¶
type DeleteConnectionOutput struct { // A description of the App Runner connection that this request just deleted. Connection *types.Connection // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteServiceInput ¶
type DeleteServiceInput struct { // The Amazon Resource Name (ARN) of the App Runner service that you want to // delete. // // This member is required. ServiceArn *string }
type DeleteServiceOutput ¶
type DeleteServiceOutput struct { // The unique ID of the asynchronous operation that this request started. You can // use it combined with the ListOperations call to track the operation's progress. // // This member is required. OperationId *string // A description of the App Runner service that this request just deleted. // // This member is required. Service *types.Service // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAutoScalingConfigurationInput ¶
type DescribeAutoScalingConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that // you want a description for. The ARN can be a full auto scaling configuration // ARN, or a partial ARN ending with either .../name or .../name/revision . If a // revision isn't specified, the latest active revision is described. // // This member is required. AutoScalingConfigurationArn *string }
type DescribeAutoScalingConfigurationOutput ¶
type DescribeAutoScalingConfigurationOutput struct { // A full description of the App Runner auto scaling configuration that you // specified in this request. // // This member is required. AutoScalingConfiguration *types.AutoScalingConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeCustomDomainsAPIClient ¶
type DescribeCustomDomainsAPIClient interface {
DescribeCustomDomains(context.Context, *DescribeCustomDomainsInput, ...func(*Options)) (*DescribeCustomDomainsOutput, error)
}
DescribeCustomDomainsAPIClient is a client that implements the DescribeCustomDomains operation.
type DescribeCustomDomainsInput ¶
type DescribeCustomDomainsInput struct { // The Amazon Resource Name (ARN) of the App Runner service that you want // associated custom domain names to be described for. // // This member is required. ServiceArn *string // The maximum number of results that each response (result page) can include. It's // used for a paginated request. If you don't specify MaxResults, the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. It's used for a paginated request. The // request retrieves the next result page. All other parameter values must be // identical to the ones that are specified in the initial request. If you don't // specify NextToken, the request retrieves the first result page. NextToken *string }
type DescribeCustomDomainsOutput ¶
type DescribeCustomDomainsOutput struct { // A list of descriptions of custom domain names that are associated with the // service. In a paginated request, the request returns up to MaxResults records // per call. // // This member is required. CustomDomains []types.CustomDomain // The App Runner subdomain of the App Runner service. The associated custom domain // names are mapped to this target name. // // This member is required. DNSTarget *string // The Amazon Resource Name (ARN) of the App Runner service whose associated custom // domain names you want to describe. // // This member is required. ServiceArn *string // The token that you can pass in a subsequent request to get the next result page. // It's returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeCustomDomainsPaginator ¶
type DescribeCustomDomainsPaginator struct {
// contains filtered or unexported fields
}
DescribeCustomDomainsPaginator is a paginator for DescribeCustomDomains
func NewDescribeCustomDomainsPaginator ¶
func NewDescribeCustomDomainsPaginator(client DescribeCustomDomainsAPIClient, params *DescribeCustomDomainsInput, optFns ...func(*DescribeCustomDomainsPaginatorOptions)) *DescribeCustomDomainsPaginator
NewDescribeCustomDomainsPaginator returns a new DescribeCustomDomainsPaginator
func (*DescribeCustomDomainsPaginator) HasMorePages ¶
func (p *DescribeCustomDomainsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeCustomDomainsPaginator) NextPage ¶
func (p *DescribeCustomDomainsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeCustomDomainsOutput, error)
NextPage retrieves the next DescribeCustomDomains page.
type DescribeCustomDomainsPaginatorOptions ¶
type DescribeCustomDomainsPaginatorOptions struct { // The maximum number of results that each response (result page) can include. It's // used for a paginated request. If you don't specify MaxResults, the request // retrieves all available results in a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeCustomDomainsPaginatorOptions is the paginator options for DescribeCustomDomains
type DescribeServiceInput ¶
type DescribeServiceInput struct { // The Amazon Resource Name (ARN) of the App Runner service that you want a // description for. // // This member is required. ServiceArn *string }
type DescribeServiceOutput ¶
type DescribeServiceOutput struct { // A full description of the App Runner service that you specified in this request. // // This member is required. Service *types.Service // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisassociateCustomDomainInput ¶
type DisassociateCustomDomainInput struct { // The domain name that you want to disassociate from the App Runner service. // // This member is required. DomainName *string // The Amazon Resource Name (ARN) of the App Runner service that you want to // disassociate a custom domain name from. // // This member is required. ServiceArn *string }
type DisassociateCustomDomainOutput ¶
type DisassociateCustomDomainOutput struct { // A description of the domain name that's being disassociated. // // This member is required. CustomDomain *types.CustomDomain // The App Runner subdomain of the App Runner service. The disassociated custom // domain name was mapped to this target name. // // This member is required. DNSTarget *string // The Amazon Resource Name (ARN) of the App Runner service that a custom domain // name is disassociated from. // // This member is required. ServiceArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type HTTPSignerV4 ¶
type ListAutoScalingConfigurationsAPIClient ¶
type ListAutoScalingConfigurationsAPIClient interface {
ListAutoScalingConfigurations(context.Context, *ListAutoScalingConfigurationsInput, ...func(*Options)) (*ListAutoScalingConfigurationsOutput, error)
}
ListAutoScalingConfigurationsAPIClient is a client that implements the ListAutoScalingConfigurations operation.
type ListAutoScalingConfigurationsInput ¶
type ListAutoScalingConfigurationsInput struct { // The name of the App Runner auto scaling configuration that you want to list. If // specified, App Runner lists revisions that share this name. If not specified, // App Runner returns revisions of all configurations. AutoScalingConfigurationName *string // Set to true to list only the latest revision for each requested configuration // name. Keep as false to list all revisions for each requested configuration name. // Default: false LatestOnly bool // The maximum number of results to include in each response (result page). It's // used for a paginated request. If you don't specify MaxResults, the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. It's used for a paginated request. The // request retrieves the next result page. All other parameter values must be // identical to the ones that are specified in the initial request. If you don't // specify NextToken, the request retrieves the first result page. NextToken *string }
type ListAutoScalingConfigurationsOutput ¶
type ListAutoScalingConfigurationsOutput struct { // A list of summary information records for auto scaling configurations. In a // paginated request, the request returns up to MaxResults records for each call. // // This member is required. AutoScalingConfigurationSummaryList []types.AutoScalingConfigurationSummary // The token that you can pass in a subsequent request to get the next result page. // It's returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListAutoScalingConfigurationsPaginator ¶
type ListAutoScalingConfigurationsPaginator struct {
// contains filtered or unexported fields
}
ListAutoScalingConfigurationsPaginator is a paginator for ListAutoScalingConfigurations
func NewListAutoScalingConfigurationsPaginator ¶
func NewListAutoScalingConfigurationsPaginator(client ListAutoScalingConfigurationsAPIClient, params *ListAutoScalingConfigurationsInput, optFns ...func(*ListAutoScalingConfigurationsPaginatorOptions)) *ListAutoScalingConfigurationsPaginator
NewListAutoScalingConfigurationsPaginator returns a new ListAutoScalingConfigurationsPaginator
func (*ListAutoScalingConfigurationsPaginator) HasMorePages ¶
func (p *ListAutoScalingConfigurationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAutoScalingConfigurationsPaginator) NextPage ¶
func (p *ListAutoScalingConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAutoScalingConfigurationsOutput, error)
NextPage retrieves the next ListAutoScalingConfigurations page.
type ListAutoScalingConfigurationsPaginatorOptions ¶
type ListAutoScalingConfigurationsPaginatorOptions struct { // The maximum number of results to include in each response (result page). It's // used for a paginated request. If you don't specify MaxResults, the request // retrieves all available results in a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAutoScalingConfigurationsPaginatorOptions is the paginator options for ListAutoScalingConfigurations
type ListConnectionsAPIClient ¶
type ListConnectionsAPIClient interface {
ListConnections(context.Context, *ListConnectionsInput, ...func(*Options)) (*ListConnectionsOutput, error)
}
ListConnectionsAPIClient is a client that implements the ListConnections operation.
type ListConnectionsInput ¶
type ListConnectionsInput struct { // If specified, only this connection is returned. If not specified, the result // isn't filtered by name. ConnectionName *string // The maximum number of results to include in each response (result page). Used // for a paginated request. If you don't specify MaxResults, the request retrieves // all available results in a single response. MaxResults *int32 // A token from a previous result page. Used for a paginated request. The request // retrieves the next result page. All other parameter values must be identical to // the ones specified in the initial request. If you don't specify NextToken, the // request retrieves the first result page. NextToken *string }
type ListConnectionsOutput ¶
type ListConnectionsOutput struct { // A list of summary information records for connections. In a paginated request, // the request returns up to MaxResults records for each call. // // This member is required. ConnectionSummaryList []types.ConnectionSummary // The token that you can pass in a subsequent request to get the next result page. // Returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListConnectionsPaginator ¶
type ListConnectionsPaginator struct {
// contains filtered or unexported fields
}
ListConnectionsPaginator is a paginator for ListConnections
func NewListConnectionsPaginator ¶
func NewListConnectionsPaginator(client ListConnectionsAPIClient, params *ListConnectionsInput, optFns ...func(*ListConnectionsPaginatorOptions)) *ListConnectionsPaginator
NewListConnectionsPaginator returns a new ListConnectionsPaginator
func (*ListConnectionsPaginator) HasMorePages ¶
func (p *ListConnectionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListConnectionsPaginator) NextPage ¶
func (p *ListConnectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConnectionsOutput, error)
NextPage retrieves the next ListConnections page.
type ListConnectionsPaginatorOptions ¶
type ListConnectionsPaginatorOptions struct { // The maximum number of results to include in each response (result page). Used // for a paginated request. If you don't specify MaxResults, the request retrieves // all available results in a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListConnectionsPaginatorOptions is the paginator options for ListConnections
type ListOperationsAPIClient ¶
type ListOperationsAPIClient interface {
ListOperations(context.Context, *ListOperationsInput, ...func(*Options)) (*ListOperationsOutput, error)
}
ListOperationsAPIClient is a client that implements the ListOperations operation.
type ListOperationsInput ¶
type ListOperationsInput struct { // The Amazon Resource Name (ARN) of the App Runner service that you want a list of // operations for. // // This member is required. ServiceArn *string // The maximum number of results to include in each response (result page). It's // used for a paginated request. If you don't specify MaxResults, the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. It's used for a paginated request. The // request retrieves the next result page. All other parameter values must be // identical to the ones specified in the initial request. If you don't specify // NextToken, the request retrieves the first result page. NextToken *string }
type ListOperationsOutput ¶
type ListOperationsOutput struct { // The token that you can pass in a subsequent request to get the next result page. // It's returned in a paginated request. NextToken *string // A list of operation summary information records. In a paginated request, the // request returns up to MaxResults records for each call. OperationSummaryList []types.OperationSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListOperationsPaginator ¶
type ListOperationsPaginator struct {
// contains filtered or unexported fields
}
ListOperationsPaginator is a paginator for ListOperations
func NewListOperationsPaginator ¶
func NewListOperationsPaginator(client ListOperationsAPIClient, params *ListOperationsInput, optFns ...func(*ListOperationsPaginatorOptions)) *ListOperationsPaginator
NewListOperationsPaginator returns a new ListOperationsPaginator
func (*ListOperationsPaginator) HasMorePages ¶
func (p *ListOperationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOperationsPaginator) NextPage ¶
func (p *ListOperationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOperationsOutput, error)
NextPage retrieves the next ListOperations page.
type ListOperationsPaginatorOptions ¶
type ListOperationsPaginatorOptions struct { // The maximum number of results to include in each response (result page). It's // used for a paginated request. If you don't specify MaxResults, the request // retrieves all available results in a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListOperationsPaginatorOptions is the paginator options for ListOperations
type ListServicesAPIClient ¶
type ListServicesAPIClient interface {
ListServices(context.Context, *ListServicesInput, ...func(*Options)) (*ListServicesOutput, error)
}
ListServicesAPIClient is a client that implements the ListServices operation.
type ListServicesInput ¶
type ListServicesInput struct { // The maximum number of results to include in each response (result page). It's // used for a paginated request. If you don't specify MaxResults, the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. Used for a paginated request. The request // retrieves the next result page. All other parameter values must be identical to // the ones specified in the initial request. If you don't specify NextToken, the // request retrieves the first result page. NextToken *string }
type ListServicesOutput ¶
type ListServicesOutput struct { // A list of service summary information records. In a paginated request, the // request returns up to MaxResults records for each call. // // This member is required. ServiceSummaryList []types.ServiceSummary // The token that you can pass in a subsequent request to get the next result page. // It's returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListServicesPaginator ¶
type ListServicesPaginator struct {
// contains filtered or unexported fields
}
ListServicesPaginator is a paginator for ListServices
func NewListServicesPaginator ¶
func NewListServicesPaginator(client ListServicesAPIClient, params *ListServicesInput, optFns ...func(*ListServicesPaginatorOptions)) *ListServicesPaginator
NewListServicesPaginator returns a new ListServicesPaginator
func (*ListServicesPaginator) HasMorePages ¶
func (p *ListServicesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListServicesPaginator) NextPage ¶
func (p *ListServicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListServicesOutput, error)
NextPage retrieves the next ListServices page.
type ListServicesPaginatorOptions ¶
type ListServicesPaginatorOptions struct { // The maximum number of results to include in each response (result page). It's // used for a paginated request. If you don't specify MaxResults, the request // retrieves all available results in a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListServicesPaginatorOptions is the paginator options for ListServices
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource that a tag list is requested for. // It must be the ARN of an App Runner resource. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // A list of the tag key-value pairs that are associated with the resource. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
type PauseServiceInput ¶
type PauseServiceInput struct { // The Amazon Resource Name (ARN) of the App Runner service that you want to pause. // // This member is required. ServiceArn *string }
type PauseServiceOutput ¶
type PauseServiceOutput struct { // A description of the App Runner service that this request just paused. // // This member is required. Service *types.Service // The unique ID of the asynchronous operation that this request started. You can // use it combined with the ListOperations call to track the operation's progress. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResumeServiceInput ¶
type ResumeServiceInput struct { // The Amazon Resource Name (ARN) of the App Runner service that you want to // resume. // // This member is required. ServiceArn *string }
type ResumeServiceOutput ¶
type ResumeServiceOutput struct { // A description of the App Runner service that this request just resumed. // // This member is required. Service *types.Service // The unique ID of the asynchronous operation that this request started. You can // use it combined with the ListOperations call to track the operation's progress. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StartDeploymentInput ¶
type StartDeploymentInput struct { // The Amazon Resource Name (ARN) of the App Runner service that you want to // manually deploy to. // // This member is required. ServiceArn *string }
type StartDeploymentOutput ¶
type StartDeploymentOutput struct { // The unique ID of the asynchronous operation that this request started. You can // use it combined with the ListOperations call to track the operation's progress. // // This member is required. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource that you want to update tags for. // It must be the ARN of an App Runner resource. // // This member is required. ResourceArn *string // A list of tag key-value pairs to add or update. If a key is new to the resource, // the tag is added with the provided value. If a key is already associated with // the resource, the value of the tag is updated. // // This member is required. Tags []types.Tag }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource that you want to remove tags // from. It must be the ARN of an App Runner resource. // // This member is required. ResourceArn *string // A list of tag keys that you want to remove. // // This member is required. TagKeys []string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateServiceInput ¶
type UpdateServiceInput struct { // The Amazon Resource Name (ARN) of the App Runner service that you want to // update. // // This member is required. ServiceArn *string // The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration // resource that you want to associate with your service. AutoScalingConfigurationArn *string // The settings for the health check that AWS App Runner performs to monitor the // health of your service. HealthCheckConfiguration *types.HealthCheckConfiguration // The runtime configuration to apply to instances (scaling units) of the App // Runner service. InstanceConfiguration *types.InstanceConfiguration // The source configuration to apply to the App Runner service. You can change the // configuration of the code or image repository that the service uses. However, // you can't switch from code to image or the other way around. This means that you // must provide the same structure member of SourceConfiguration that you // originally included when you created the service. Specifically, you can include // either CodeRepository or ImageRepository. To update the source configuration, // set the values to members of the structure that you include. SourceConfiguration *types.SourceConfiguration }
type UpdateServiceOutput ¶
type UpdateServiceOutput struct { // The unique ID of the asynchronous operation that this request started. You can // use it combined with the ListOperations call to track the operation's progress. // // This member is required. OperationId *string // A description of the App Runner service updated by this request. All // configuration values in the returned Service structure reflect configuration // changes that are being applied by this request. // // This member is required. Service *types.Service // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
- api_client.go
- api_op_AssociateCustomDomain.go
- api_op_CreateAutoScalingConfiguration.go
- api_op_CreateConnection.go
- api_op_CreateService.go
- api_op_DeleteAutoScalingConfiguration.go
- api_op_DeleteConnection.go
- api_op_DeleteService.go
- api_op_DescribeAutoScalingConfiguration.go
- api_op_DescribeCustomDomains.go
- api_op_DescribeService.go
- api_op_DisassociateCustomDomain.go
- api_op_ListAutoScalingConfigurations.go
- api_op_ListConnections.go
- api_op_ListOperations.go
- api_op_ListServices.go
- api_op_ListTagsForResource.go
- api_op_PauseService.go
- api_op_ResumeService.go
- api_op_StartDeployment.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateService.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go