Documentation ¶
Overview ¶
Package apprunner provides the API client, operations, and parameter types for AWS App Runner.
App Runner ¶
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 Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and configure Amazon Web Services 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 App Runner Developer Guide. For release information, see the App Runner Release Notes.
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.
Endpoints ¶
For a list of Region-specific endpoints that App Runner supports, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AssociateCustomDomainInput
- type AssociateCustomDomainOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- 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) CreateObservabilityConfiguration(ctx context.Context, params *CreateObservabilityConfigurationInput, ...) (*CreateObservabilityConfigurationOutput, error)
- func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error)
- func (c *Client) CreateVpcConnector(ctx context.Context, params *CreateVpcConnectorInput, optFns ...func(*Options)) (*CreateVpcConnectorOutput, error)
- func (c *Client) CreateVpcIngressConnection(ctx context.Context, params *CreateVpcIngressConnectionInput, ...) (*CreateVpcIngressConnectionOutput, 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) DeleteObservabilityConfiguration(ctx context.Context, params *DeleteObservabilityConfigurationInput, ...) (*DeleteObservabilityConfigurationOutput, error)
- func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, optFns ...func(*Options)) (*DeleteServiceOutput, error)
- func (c *Client) DeleteVpcConnector(ctx context.Context, params *DeleteVpcConnectorInput, optFns ...func(*Options)) (*DeleteVpcConnectorOutput, error)
- func (c *Client) DeleteVpcIngressConnection(ctx context.Context, params *DeleteVpcIngressConnectionInput, ...) (*DeleteVpcIngressConnectionOutput, 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) DescribeObservabilityConfiguration(ctx context.Context, params *DescribeObservabilityConfigurationInput, ...) (*DescribeObservabilityConfigurationOutput, error)
- func (c *Client) DescribeService(ctx context.Context, params *DescribeServiceInput, optFns ...func(*Options)) (*DescribeServiceOutput, error)
- func (c *Client) DescribeVpcConnector(ctx context.Context, params *DescribeVpcConnectorInput, ...) (*DescribeVpcConnectorOutput, error)
- func (c *Client) DescribeVpcIngressConnection(ctx context.Context, params *DescribeVpcIngressConnectionInput, ...) (*DescribeVpcIngressConnectionOutput, 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) ListObservabilityConfigurations(ctx context.Context, params *ListObservabilityConfigurationsInput, ...) (*ListObservabilityConfigurationsOutput, 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) ListServicesForAutoScalingConfiguration(ctx context.Context, params *ListServicesForAutoScalingConfigurationInput, ...) (*ListServicesForAutoScalingConfigurationOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ListVpcConnectors(ctx context.Context, params *ListVpcConnectorsInput, optFns ...func(*Options)) (*ListVpcConnectorsOutput, error)
- func (c *Client) ListVpcIngressConnections(ctx context.Context, params *ListVpcIngressConnectionsInput, ...) (*ListVpcIngressConnectionsOutput, error)
- func (c *Client) Options() Options
- 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) UpdateDefaultAutoScalingConfiguration(ctx context.Context, params *UpdateDefaultAutoScalingConfigurationInput, ...) (*UpdateDefaultAutoScalingConfigurationOutput, error)
- func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error)
- func (c *Client) UpdateVpcIngressConnection(ctx context.Context, params *UpdateVpcIngressConnectionInput, ...) (*UpdateVpcIngressConnectionOutput, error)
- type CreateAutoScalingConfigurationInput
- type CreateAutoScalingConfigurationOutput
- type CreateConnectionInput
- type CreateConnectionOutput
- type CreateObservabilityConfigurationInput
- type CreateObservabilityConfigurationOutput
- type CreateServiceInput
- type CreateServiceOutput
- type CreateVpcConnectorInput
- type CreateVpcConnectorOutput
- type CreateVpcIngressConnectionInput
- type CreateVpcIngressConnectionOutput
- type DeleteAutoScalingConfigurationInput
- type DeleteAutoScalingConfigurationOutput
- type DeleteConnectionInput
- type DeleteConnectionOutput
- type DeleteObservabilityConfigurationInput
- type DeleteObservabilityConfigurationOutput
- type DeleteServiceInput
- type DeleteServiceOutput
- type DeleteVpcConnectorInput
- type DeleteVpcConnectorOutput
- type DeleteVpcIngressConnectionInput
- type DeleteVpcIngressConnectionOutput
- type DescribeAutoScalingConfigurationInput
- type DescribeAutoScalingConfigurationOutput
- type DescribeCustomDomainsAPIClient
- type DescribeCustomDomainsInput
- type DescribeCustomDomainsOutput
- type DescribeCustomDomainsPaginator
- type DescribeCustomDomainsPaginatorOptions
- type DescribeObservabilityConfigurationInput
- type DescribeObservabilityConfigurationOutput
- type DescribeServiceInput
- type DescribeServiceOutput
- type DescribeVpcConnectorInput
- type DescribeVpcConnectorOutput
- type DescribeVpcIngressConnectionInput
- type DescribeVpcIngressConnectionOutput
- type DisassociateCustomDomainInput
- type DisassociateCustomDomainOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- 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 ListObservabilityConfigurationsAPIClient
- type ListObservabilityConfigurationsInput
- type ListObservabilityConfigurationsOutput
- type ListObservabilityConfigurationsPaginator
- type ListObservabilityConfigurationsPaginatorOptions
- type ListOperationsAPIClient
- type ListOperationsInput
- type ListOperationsOutput
- type ListOperationsPaginator
- type ListOperationsPaginatorOptions
- type ListServicesAPIClient
- type ListServicesForAutoScalingConfigurationAPIClient
- type ListServicesForAutoScalingConfigurationInput
- type ListServicesForAutoScalingConfigurationOutput
- type ListServicesForAutoScalingConfigurationPaginator
- type ListServicesForAutoScalingConfigurationPaginatorOptions
- type ListServicesInput
- type ListServicesOutput
- type ListServicesPaginator
- type ListServicesPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListVpcConnectorsAPIClient
- type ListVpcConnectorsInput
- type ListVpcConnectorsOutput
- type ListVpcConnectorsPaginator
- type ListVpcConnectorsPaginatorOptions
- type ListVpcIngressConnectionsAPIClient
- type ListVpcIngressConnectionsInput
- type ListVpcIngressConnectionsOutput
- type ListVpcIngressConnectionsPaginator
- type ListVpcIngressConnectionsPaginatorOptions
- 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 UpdateDefaultAutoScalingConfigurationInput
- type UpdateDefaultAutoScalingConfigurationOutput
- type UpdateServiceInput
- type UpdateServiceOutput
- type UpdateVpcIngressConnectionInput
- type UpdateVpcIngressConnectionOutput
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
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
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 // contains filtered or unexported fields }
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 // DNS Target records for the custom domains of this Amazon VPC. // // This member is required. VpcDNSTargets []types.VpcDNSTarget // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
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 App Runner subdomain URL of your App Runner service.
After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomainrecord 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).
func (*Client) CreateAutoScalingConfiguration ¶
func (c *Client) CreateAutoScalingConfiguration(ctx context.Context, params *CreateAutoScalingConfigurationInput, optFns ...func(*Options)) (*CreateAutoScalingConfigurationOutput, error)
Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.
Create multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName . The call returns incremental AutoScalingConfigurationRevision values. When you create a service and configure an auto scaling configuration resource, the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific revision.
Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services 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 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 and Bitbucket repositories. Both require a user interface approval process through the App Runner console before you can use the connection.
func (*Client) CreateObservabilityConfiguration ¶
func (c *Client) CreateObservabilityConfiguration(ctx context.Context, params *CreateObservabilityConfigurationInput, optFns ...func(*Options)) (*CreateObservabilityConfigurationOutput, error)
Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services.
Create multiple revisions of a configuration by calling this action multiple times using the same ObservabilityConfigurationName . The call returns incremental ObservabilityConfigurationRevision values. When you create a service and configure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific revision.
The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional parameters that describe the configuration of these features (currently one parameter, TraceConfiguration ). If you don't specify a feature parameter, App Runner doesn't enable the feature.
func (*Client) CreateService ¶
func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error)
Create an 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 call to track the operation's progress.
func (*Client) CreateVpcConnector ¶
func (c *Client) CreateVpcConnector(ctx context.Context, params *CreateVpcConnectorInput, optFns ...func(*Options)) (*CreateVpcConnectorOutput, error)
Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).
func (*Client) CreateVpcIngressConnection ¶
func (c *Client) CreateVpcIngressConnection(ctx context.Context, params *CreateVpcIngressConnectionInput, optFns ...func(*Options)) (*CreateVpcIngressConnectionOutput, error)
Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.
func (*Client) DeleteAutoScalingConfiguration ¶
func (c *Client) DeleteAutoScalingConfiguration(ctx context.Context, params *DeleteAutoScalingConfigurationInput, optFns ...func(*Options)) (*DeleteAutoScalingConfigurationOutput, error)
Delete an App Runner automatic scaling configuration resource. You can delete a top level auto scaling configuration, a specific revision of one, or all revisions associated with the top level configuration. You can't delete the default auto scaling configuration or 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 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) DeleteObservabilityConfiguration ¶
func (c *Client) DeleteObservabilityConfiguration(ctx context.Context, params *DeleteObservabilityConfigurationInput, optFns ...func(*Options)) (*DeleteObservabilityConfigurationOutput, error)
Delete an App Runner observability 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) DeleteService ¶
func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, optFns ...func(*Options)) (*DeleteServiceOutput, error)
Delete an 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.
Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete.
func (*Client) DeleteVpcConnector ¶
func (c *Client) DeleteVpcConnector(ctx context.Context, params *DeleteVpcConnectorInput, optFns ...func(*Options)) (*DeleteVpcConnectorOutput, error)
Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.
func (*Client) DeleteVpcIngressConnection ¶
func (c *Client) DeleteVpcIngressConnection(ctx context.Context, params *DeleteVpcIngressConnectionInput, optFns ...func(*Options)) (*DeleteVpcIngressConnectionOutput, error)
Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted:
AVAILABLE
FAILED_CREATION
FAILED_UPDATE
FAILED_DELETION
func (*Client) DescribeAutoScalingConfiguration ¶
func (c *Client) DescribeAutoScalingConfiguration(ctx context.Context, params *DescribeAutoScalingConfigurationInput, optFns ...func(*Options)) (*DescribeAutoScalingConfigurationOutput, error)
Return a full description of an 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 App Runner service.
func (*Client) DescribeObservabilityConfiguration ¶
func (c *Client) DescribeObservabilityConfiguration(ctx context.Context, params *DescribeObservabilityConfigurationInput, optFns ...func(*Options)) (*DescribeObservabilityConfigurationOutput, error)
Return a full description of an App Runner observability configuration resource.
func (*Client) DescribeService ¶
func (c *Client) DescribeService(ctx context.Context, params *DescribeServiceInput, optFns ...func(*Options)) (*DescribeServiceOutput, error)
Return a full description of an App Runner service.
func (*Client) DescribeVpcConnector ¶
func (c *Client) DescribeVpcConnector(ctx context.Context, params *DescribeVpcConnectorInput, optFns ...func(*Options)) (*DescribeVpcConnectorOutput, error)
Return a description of an App Runner VPC connector resource.
func (*Client) DescribeVpcIngressConnection ¶
func (c *Client) DescribeVpcIngressConnection(ctx context.Context, params *DescribeVpcIngressConnectionInput, optFns ...func(*Options)) (*DescribeVpcIngressConnectionOutput, error)
Return a full description of an App Runner VPC Ingress Connection resource.
func (*Client) DisassociateCustomDomain ¶
func (c *Client) DisassociateCustomDomain(ctx context.Context, params *DisassociateCustomDomainInput, optFns ...func(*Options)) (*DisassociateCustomDomainOutput, error)
Disassociate a custom domain name from an App Runner service.
Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). 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 active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.
To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListAutoScalingConfigurations .
func (*Client) ListConnections ¶
func (c *Client) ListConnections(ctx context.Context, params *ListConnectionsInput, optFns ...func(*Options)) (*ListConnectionsOutput, error)
Returns a list of App Runner connections that are associated with your Amazon Web Services account.
func (*Client) ListObservabilityConfigurations ¶
func (c *Client) ListObservabilityConfigurations(ctx context.Context, params *ListObservabilityConfigurationsInput, optFns ...func(*Options)) (*ListObservabilityConfigurationsOutput, error)
Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.
To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListObservabilityConfigurations .
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 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 App Runner services in your Amazon Web Services account.
func (*Client) ListServicesForAutoScalingConfiguration ¶
func (c *Client) ListServicesForAutoScalingConfiguration(ctx context.Context, params *ListServicesForAutoScalingConfigurationInput, optFns ...func(*Options)) (*ListServicesForAutoScalingConfigurationOutput, error)
Returns a list of the associated App Runner services using an auto scaling configuration.
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 App Runner resource. The response contains a list of tag key-value pairs.
func (*Client) ListVpcConnectors ¶
func (c *Client) ListVpcConnectors(ctx context.Context, params *ListVpcConnectorsInput, optFns ...func(*Options)) (*ListVpcConnectorsOutput, error)
Returns a list of App Runner VPC connectors in your Amazon Web Services account.
func (*Client) ListVpcIngressConnections ¶
func (c *Client) ListVpcIngressConnections(ctx context.Context, params *ListVpcIngressConnectionsInput, optFns ...func(*Options)) (*ListVpcIngressConnectionsOutput, error)
Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.
func (*Client) Options ¶
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) PauseService ¶
func (c *Client) PauseService(ctx context.Context, params *PauseServiceInput, optFns ...func(*Options)) (*PauseServiceOutput, error)
Pause an active 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 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 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) UpdateDefaultAutoScalingConfiguration ¶
func (c *Client) UpdateDefaultAutoScalingConfiguration(ctx context.Context, params *UpdateDefaultAutoScalingConfigurationInput, optFns ...func(*Options)) (*UpdateDefaultAutoScalingConfigurationOutput, error)
Update an auto scaling configuration to be the default. The existing default auto scaling configuration will be set to non-default automatically.
func (*Client) UpdateService ¶
func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error)
Update an 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.
func (*Client) UpdateVpcIngressConnection ¶
func (c *Client) UpdateVpcIngressConnection(ctx context.Context, params *UpdateVpcIngressConnectionInput, optFns ...func(*Options)) (*UpdateVpcIngressConnectionOutput, error)
Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:
AVAILABLE
FAILED_CREATION
FAILED_UPDATE
type CreateAutoScalingConfigurationInput ¶
type CreateAutoScalingConfigurationInput struct { // A name for the auto scaling configuration. When you use it for the first time // in an Amazon Web Services 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. // // Prior to the release of [Auto scale configuration enhancements], the name DefaultConfiguration was reserved. // // This restriction is no longer in place. You can now manage DefaultConfiguration // the same way you manage your custom auto scaling configurations. This means you // can do the following with the DefaultConfiguration that App Runner provides: // // - Create new revisions of the DefaultConfiguration . // // - Delete the revisions of the DefaultConfiguration . // // - Delete the auto scaling configuration for which the App Runner // DefaultConfiguration was created. // // - If you delete the auto scaling configuration you can create another custom // auto scaling configuration with the same DefaultConfiguration name. The // original DefaultConfiguration resource provided by App Runner remains in your // account unless you make changes to it. // // [Auto scale configuration enhancements]: https://docs.aws.amazon.com/apprunner/latest/relnotes/release-2023-09-22-auto-scale-config.html // // 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type CreateConnectionInput ¶
type CreateConnectionInput struct { // A name for the new connection. It must be unique across all App Runner // connections for the Amazon Web Services account in the Amazon Web Services // 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type CreateObservabilityConfigurationInput ¶
type CreateObservabilityConfigurationInput struct { // A name for the observability configuration. When you use it for the first time // in an Amazon Web Services 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. // // The name DefaultConfiguration is reserved. You can't use it to create a new // observability configuration, and you can't create a revision of it. // // When you want to use your own observability configuration for your App Runner // service, create a configuration with a different name, and then provide it when // you create or update your service. // // This member is required. ObservabilityConfigurationName *string // A list of metadata items that you can associate with your observability // configuration resource. A tag is a key-value pair. Tags []types.Tag // The configuration of the tracing feature within this observability // configuration. If you don't specify it, App Runner doesn't enable tracing. TraceConfiguration *types.TraceConfiguration // contains filtered or unexported fields }
type CreateObservabilityConfigurationOutput ¶
type CreateObservabilityConfigurationOutput struct { // A description of the App Runner observability configuration that's created by // this request. // // This member is required. ObservabilityConfiguration *types.ObservabilityConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateServiceInput ¶
type CreateServiceInput struct { // A name for the App Runner service. It must be unique across all the running App // Runner services in your Amazon Web Services account in the Amazon Web Services // 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. // // Specify an ARN with a name and a revision number to associate that revision. // For example: // arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3 // // Specify just the name to associate the latest revision. For example: // arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability 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 Amazon Web Services managed key. EncryptionConfiguration *types.EncryptionConfiguration // The settings for the health check that App Runner performs to monitor the // health of the App Runner service. HealthCheckConfiguration *types.HealthCheckConfiguration // The runtime configuration of instances (scaling units) of your service. InstanceConfiguration *types.InstanceConfiguration // Configuration settings related to network traffic of the web application that // the App Runner service runs. NetworkConfiguration *types.NetworkConfiguration // The observability configuration of your service. ObservabilityConfiguration *types.ServiceObservabilityConfiguration // An optional list of metadata items that you can associate with the App Runner // service resource. A tag is a key-value pair. Tags []types.Tag // contains filtered or unexported fields }
type CreateServiceOutput ¶
type CreateServiceOutput 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. // // [ListOperations]: https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html // // 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 // contains filtered or unexported fields }
type CreateVpcConnectorInput ¶
type CreateVpcConnectorInput struct { // A list of IDs of subnets that App Runner should use when it associates your // service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. // App Runner determines the Amazon VPC from the subnets you specify. // // App Runner currently only provides support for IPv4. // // This member is required. Subnets []string // A name for the VPC connector. // // This member is required. VpcConnectorName *string // A list of IDs of security groups that App Runner should use 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 // A list of metadata items that you can associate with your VPC connector // resource. A tag is a key-value pair. Tags []types.Tag // contains filtered or unexported fields }
type CreateVpcConnectorOutput ¶
type CreateVpcConnectorOutput struct { // A description of the App Runner VPC connector that's created by this request. // // This member is required. VpcConnector *types.VpcConnector // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateVpcIngressConnectionInput ¶
type CreateVpcIngressConnectionInput struct { // Specifications for the customer’s Amazon VPC and the related Amazon Web // Services PrivateLink VPC endpoint that are used to create the VPC Ingress // Connection resource. // // This member is required. IngressVpcConfiguration *types.IngressVpcConfiguration // The Amazon Resource Name (ARN) for this App Runner service that is used to // create the VPC Ingress Connection resource. // // This member is required. ServiceArn *string // A name for the VPC Ingress Connection resource. It must be unique across all // the active VPC Ingress Connections in your Amazon Web Services account in the // Amazon Web Services Region. // // This member is required. VpcIngressConnectionName *string // An optional list of metadata items that you can associate with the VPC Ingress // Connection resource. A tag is a key-value pair. Tags []types.Tag // contains filtered or unexported fields }
type CreateVpcIngressConnectionOutput ¶
type CreateVpcIngressConnectionOutput struct { // A description of the App Runner VPC Ingress Connection resource that's created // by this request. // // This member is required. VpcIngressConnection *types.VpcIngressConnection // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // Set to true to delete all of the revisions associated with the // AutoScalingConfigurationArn parameter value. // // When DeleteAllRevisions is set to true , the only valid value for the Amazon // Resource Name (ARN) is a partial ARN ending with: .../name . DeleteAllRevisions bool // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DeleteObservabilityConfigurationInput ¶
type DeleteObservabilityConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner observability configuration // that you want to delete. // // The ARN can be a full observability 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. ObservabilityConfigurationArn *string // contains filtered or unexported fields }
type DeleteObservabilityConfigurationOutput ¶
type DeleteObservabilityConfigurationOutput struct { // A description of the App Runner observability configuration that this request // just deleted. // // This member is required. ObservabilityConfiguration *types.ObservabilityConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DeleteServiceOutput ¶
type DeleteServiceOutput struct { // The unique ID of the asynchronous operation that this request started. You can // use it combined with the ListOperationscall 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 // contains filtered or unexported fields }
type DeleteVpcConnectorInput ¶
type DeleteVpcConnectorInput struct { // The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to // delete. // // The ARN must be a full VPC connector ARN. // // This member is required. VpcConnectorArn *string // contains filtered or unexported fields }
type DeleteVpcConnectorOutput ¶
type DeleteVpcConnectorOutput struct { // A description of the App Runner VPC connector that this request just deleted. // // This member is required. VpcConnector *types.VpcConnector // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteVpcIngressConnectionInput ¶
type DeleteVpcIngressConnectionInput struct { // The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that // you want to delete. // // This member is required. VpcIngressConnectionArn *string // contains filtered or unexported fields }
type DeleteVpcIngressConnectionOutput ¶
type DeleteVpcIngressConnectionOutput struct { // A description of the App Runner VPC Ingress Connection that this request just // deleted. // // This member is required. VpcIngressConnection *types.VpcIngressConnection // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // DNS Target records for the custom domains of this Amazon VPC. // // This member is required. VpcDNSTargets []types.VpcDNSTarget // 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 // contains filtered or unexported fields }
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 DescribeObservabilityConfigurationInput ¶
type DescribeObservabilityConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner observability configuration // that you want a description for. // // The ARN can be a full observability 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. ObservabilityConfigurationArn *string // contains filtered or unexported fields }
type DescribeObservabilityConfigurationOutput ¶
type DescribeObservabilityConfigurationOutput struct { // A full description of the App Runner observability configuration that you // specified in this request. // // This member is required. ObservabilityConfiguration *types.ObservabilityConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeVpcConnectorInput ¶
type DescribeVpcConnectorInput struct { // The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a // description for. // // The ARN must be a full VPC connector ARN. // // This member is required. VpcConnectorArn *string // contains filtered or unexported fields }
type DescribeVpcConnectorOutput ¶
type DescribeVpcConnectorOutput struct { // A description of the App Runner VPC connector that you specified in this // request. // // This member is required. VpcConnector *types.VpcConnector // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeVpcIngressConnectionInput ¶
type DescribeVpcIngressConnectionInput struct { // The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that // you want a description for. // // This member is required. VpcIngressConnectionArn *string // contains filtered or unexported fields }
type DescribeVpcIngressConnectionOutput ¶
type DescribeVpcIngressConnectionOutput struct { // A description of the App Runner VPC Ingress Connection that you specified in // this request. // // This member is required. VpcIngressConnection *types.VpcIngressConnection // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // DNS Target records for the custom domains of this Amazon VPC. // // This member is required. VpcDNSTargets []types.VpcDNSTarget // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
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 EndpointResolverV2 ¶
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
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 active configurations. AutoScalingConfigurationName *string // Set to true to list only the latest revision for each requested configuration // name. // // Set to false to list all revisions for each requested configuration name. // // Default: true 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 ListObservabilityConfigurationsAPIClient ¶
type ListObservabilityConfigurationsAPIClient interface {
ListObservabilityConfigurations(context.Context, *ListObservabilityConfigurationsInput, ...func(*Options)) (*ListObservabilityConfigurationsOutput, error)
}
ListObservabilityConfigurationsAPIClient is a client that implements the ListObservabilityConfigurations operation.
type ListObservabilityConfigurationsInput ¶
type ListObservabilityConfigurationsInput struct { // Set to true to list only the latest revision for each requested configuration // name. // // Set to false to list all revisions for each requested configuration name. // // Default: true 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 // The name of the App Runner observability 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 active configurations. ObservabilityConfigurationName *string // contains filtered or unexported fields }
type ListObservabilityConfigurationsOutput ¶
type ListObservabilityConfigurationsOutput struct { // A list of summary information records for observability configurations. In a // paginated request, the request returns up to MaxResults records for each call. // // This member is required. ObservabilityConfigurationSummaryList []types.ObservabilityConfigurationSummary // 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 // contains filtered or unexported fields }
type ListObservabilityConfigurationsPaginator ¶
type ListObservabilityConfigurationsPaginator struct {
// contains filtered or unexported fields
}
ListObservabilityConfigurationsPaginator is a paginator for ListObservabilityConfigurations
func NewListObservabilityConfigurationsPaginator ¶
func NewListObservabilityConfigurationsPaginator(client ListObservabilityConfigurationsAPIClient, params *ListObservabilityConfigurationsInput, optFns ...func(*ListObservabilityConfigurationsPaginatorOptions)) *ListObservabilityConfigurationsPaginator
NewListObservabilityConfigurationsPaginator returns a new ListObservabilityConfigurationsPaginator
func (*ListObservabilityConfigurationsPaginator) HasMorePages ¶
func (p *ListObservabilityConfigurationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListObservabilityConfigurationsPaginator) NextPage ¶
func (p *ListObservabilityConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListObservabilityConfigurationsOutput, error)
NextPage retrieves the next ListObservabilityConfigurations page.
type ListObservabilityConfigurationsPaginatorOptions ¶
type ListObservabilityConfigurationsPaginatorOptions 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 }
ListObservabilityConfigurationsPaginatorOptions is the paginator options for ListObservabilityConfigurations
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 ListServicesForAutoScalingConfigurationAPIClient ¶
type ListServicesForAutoScalingConfigurationAPIClient interface {
ListServicesForAutoScalingConfiguration(context.Context, *ListServicesForAutoScalingConfigurationInput, ...func(*Options)) (*ListServicesForAutoScalingConfigurationOutput, error)
}
ListServicesForAutoScalingConfigurationAPIClient is a client that implements the ListServicesForAutoScalingConfiguration operation.
type ListServicesForAutoScalingConfigurationInput ¶
type ListServicesForAutoScalingConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration // that you want to list the services 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 used. // // This member is required. AutoScalingConfigurationArn *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 // contains filtered or unexported fields }
type ListServicesForAutoScalingConfigurationOutput ¶
type ListServicesForAutoScalingConfigurationOutput struct { // A list of service ARN records. In a paginated request, the request returns up // to MaxResults records for each call. // // This member is required. ServiceArnList []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 // contains filtered or unexported fields }
type ListServicesForAutoScalingConfigurationPaginator ¶
type ListServicesForAutoScalingConfigurationPaginator struct {
// contains filtered or unexported fields
}
ListServicesForAutoScalingConfigurationPaginator is a paginator for ListServicesForAutoScalingConfiguration
func NewListServicesForAutoScalingConfigurationPaginator ¶
func NewListServicesForAutoScalingConfigurationPaginator(client ListServicesForAutoScalingConfigurationAPIClient, params *ListServicesForAutoScalingConfigurationInput, optFns ...func(*ListServicesForAutoScalingConfigurationPaginatorOptions)) *ListServicesForAutoScalingConfigurationPaginator
NewListServicesForAutoScalingConfigurationPaginator returns a new ListServicesForAutoScalingConfigurationPaginator
func (*ListServicesForAutoScalingConfigurationPaginator) HasMorePages ¶
func (p *ListServicesForAutoScalingConfigurationPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListServicesForAutoScalingConfigurationPaginator) NextPage ¶
func (p *ListServicesForAutoScalingConfigurationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListServicesForAutoScalingConfigurationOutput, error)
NextPage retrieves the next ListServicesForAutoScalingConfiguration page.
type ListServicesForAutoScalingConfigurationPaginatorOptions ¶
type ListServicesForAutoScalingConfigurationPaginatorOptions 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 }
ListServicesForAutoScalingConfigurationPaginatorOptions is the paginator options for ListServicesForAutoScalingConfiguration
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListVpcConnectorsAPIClient ¶
type ListVpcConnectorsAPIClient interface {
ListVpcConnectors(context.Context, *ListVpcConnectorsInput, ...func(*Options)) (*ListVpcConnectorsOutput, error)
}
ListVpcConnectorsAPIClient is a client that implements the ListVpcConnectors operation.
type ListVpcConnectorsInput ¶
type ListVpcConnectorsInput 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. 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 // contains filtered or unexported fields }
type ListVpcConnectorsOutput ¶
type ListVpcConnectorsOutput struct { // A list of information records for VPC connectors. In a paginated request, the // request returns up to MaxResults records for each call. // // This member is required. VpcConnectors []types.VpcConnector // 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 // contains filtered or unexported fields }
type ListVpcConnectorsPaginator ¶
type ListVpcConnectorsPaginator struct {
// contains filtered or unexported fields
}
ListVpcConnectorsPaginator is a paginator for ListVpcConnectors
func NewListVpcConnectorsPaginator ¶
func NewListVpcConnectorsPaginator(client ListVpcConnectorsAPIClient, params *ListVpcConnectorsInput, optFns ...func(*ListVpcConnectorsPaginatorOptions)) *ListVpcConnectorsPaginator
NewListVpcConnectorsPaginator returns a new ListVpcConnectorsPaginator
func (*ListVpcConnectorsPaginator) HasMorePages ¶
func (p *ListVpcConnectorsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListVpcConnectorsPaginator) NextPage ¶
func (p *ListVpcConnectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVpcConnectorsOutput, error)
NextPage retrieves the next ListVpcConnectors page.
type ListVpcConnectorsPaginatorOptions ¶
type ListVpcConnectorsPaginatorOptions 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 }
ListVpcConnectorsPaginatorOptions is the paginator options for ListVpcConnectors
type ListVpcIngressConnectionsAPIClient ¶
type ListVpcIngressConnectionsAPIClient interface {
ListVpcIngressConnections(context.Context, *ListVpcIngressConnectionsInput, ...func(*Options)) (*ListVpcIngressConnectionsOutput, error)
}
ListVpcIngressConnectionsAPIClient is a client that implements the ListVpcIngressConnections operation.
type ListVpcIngressConnectionsInput ¶
type ListVpcIngressConnectionsInput struct { // The VPC Ingress Connections to be listed based on either the Service Arn or Vpc // Endpoint Id, or both. Filter *types.ListVpcIngressConnectionsFilter // 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 // contains filtered or unexported fields }
type ListVpcIngressConnectionsOutput ¶
type ListVpcIngressConnectionsOutput struct { // A list of summary information records for VPC Ingress Connections. In a // paginated request, the request returns up to MaxResults records for each call. // // This member is required. VpcIngressConnectionSummaryList []types.VpcIngressConnectionSummary // 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 // contains filtered or unexported fields }
type ListVpcIngressConnectionsPaginator ¶
type ListVpcIngressConnectionsPaginator struct {
// contains filtered or unexported fields
}
ListVpcIngressConnectionsPaginator is a paginator for ListVpcIngressConnections
func NewListVpcIngressConnectionsPaginator ¶
func NewListVpcIngressConnectionsPaginator(client ListVpcIngressConnectionsAPIClient, params *ListVpcIngressConnectionsInput, optFns ...func(*ListVpcIngressConnectionsPaginatorOptions)) *ListVpcIngressConnectionsPaginator
NewListVpcIngressConnectionsPaginator returns a new ListVpcIngressConnectionsPaginator
func (*ListVpcIngressConnectionsPaginator) HasMorePages ¶
func (p *ListVpcIngressConnectionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListVpcIngressConnectionsPaginator) NextPage ¶
func (p *ListVpcIngressConnectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVpcIngressConnectionsOutput, error)
NextPage retrieves the next ListVpcIngressConnections page.
type ListVpcIngressConnectionsPaginatorOptions ¶
type ListVpcIngressConnectionsPaginatorOptions 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 }
ListVpcIngressConnectionsPaginatorOptions is the paginator options for ListVpcIngressConnections
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 // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // 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 configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // 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 // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
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 // contains filtered or unexported fields }
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 ListOperationscall to track the operation's progress. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 ListOperationscall to track the operation's progress. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type StartDeploymentOutput ¶
type StartDeploymentOutput struct { // The unique ID of the asynchronous operation that this request started. You can // use it combined with the ListOperationscall to track the operation's progress. // // This member is required. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateDefaultAutoScalingConfigurationInput ¶
type UpdateDefaultAutoScalingConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration // that you want to set as the default. // // 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 set as the default. // // This member is required. AutoScalingConfigurationArn *string // contains filtered or unexported fields }
type UpdateDefaultAutoScalingConfigurationOutput ¶
type UpdateDefaultAutoScalingConfigurationOutput struct { // A description of the App Runner auto scaling configuration that was set as // default. // // This member is required. AutoScalingConfiguration *types.AutoScalingConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 the App Runner service. AutoScalingConfigurationArn *string // The settings for the health check that App Runner performs to monitor the // health of the App Runner service. HealthCheckConfiguration *types.HealthCheckConfiguration // The runtime configuration to apply to instances (scaling units) of your service. InstanceConfiguration *types.InstanceConfiguration // Configuration settings related to network traffic of the web application that // the App Runner service runs. NetworkConfiguration *types.NetworkConfiguration // The observability configuration of your service. ObservabilityConfiguration *types.ServiceObservabilityConfiguration // 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 // contains filtered or unexported fields }
type UpdateServiceOutput ¶
type UpdateServiceOutput struct { // The unique ID of the asynchronous operation that this request started. You can // use it combined with the ListOperationscall 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 // contains filtered or unexported fields }
type UpdateVpcIngressConnectionInput ¶
type UpdateVpcIngressConnectionInput struct { // Specifications for the customer’s Amazon VPC and the related Amazon Web // Services PrivateLink VPC endpoint that are used to update the VPC Ingress // Connection resource. // // This member is required. IngressVpcConfiguration *types.IngressVpcConfiguration // The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection // resource that you want to update. // // This member is required. VpcIngressConnectionArn *string // contains filtered or unexported fields }
type UpdateVpcIngressConnectionOutput ¶
type UpdateVpcIngressConnectionOutput struct { // A description of the App Runner VPC Ingress Connection resource that's updated // by this request. // // This member is required. VpcIngressConnection *types.VpcIngressConnection // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_AssociateCustomDomain.go
- api_op_CreateAutoScalingConfiguration.go
- api_op_CreateConnection.go
- api_op_CreateObservabilityConfiguration.go
- api_op_CreateService.go
- api_op_CreateVpcConnector.go
- api_op_CreateVpcIngressConnection.go
- api_op_DeleteAutoScalingConfiguration.go
- api_op_DeleteConnection.go
- api_op_DeleteObservabilityConfiguration.go
- api_op_DeleteService.go
- api_op_DeleteVpcConnector.go
- api_op_DeleteVpcIngressConnection.go
- api_op_DescribeAutoScalingConfiguration.go
- api_op_DescribeCustomDomains.go
- api_op_DescribeObservabilityConfiguration.go
- api_op_DescribeService.go
- api_op_DescribeVpcConnector.go
- api_op_DescribeVpcIngressConnection.go
- api_op_DisassociateCustomDomain.go
- api_op_ListAutoScalingConfigurations.go
- api_op_ListConnections.go
- api_op_ListObservabilityConfigurations.go
- api_op_ListOperations.go
- api_op_ListServices.go
- api_op_ListServicesForAutoScalingConfiguration.go
- api_op_ListTagsForResource.go
- api_op_ListVpcConnectors.go
- api_op_ListVpcIngressConnections.go
- api_op_PauseService.go
- api_op_ResumeService.go
- api_op_StartDeployment.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateDefaultAutoScalingConfiguration.go
- api_op_UpdateService.go
- api_op_UpdateVpcIngressConnection.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go