elasticbeanstalk

package module
v1.28.7 Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2024 License: Apache-2.0 Imports: 48 Imported by: 58

Documentation

Overview

Package elasticbeanstalk provides the API client, operations, and parameter types for AWS Elastic Beanstalk.

AWS Elastic Beanstalk

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.

Endpoints

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpointsin the Amazon Web Services Glossary.

Index

Constants

View Source 
const ServiceAPIVersion = "2010-12-01"
View Source 
const ServiceID = "Elastic Beanstalk"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

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 added in v1.16.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.19.2 

func WithSigV4SigningName(name string) func(*Options)

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 added in v1.19.2 

func WithSigV4SigningRegion(region string) func(*Options)

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 AbortEnvironmentUpdateInput 

type AbortEnvironmentUpdateInput struct {

	// This specifies the ID of the environment with the in-progress update that you
	// want to cancel.
	EnvironmentId *string

	// This specifies the name of the environment with the in-progress update that you
	// want to cancel.
	EnvironmentName *string
	// contains filtered or unexported fields
}

type AbortEnvironmentUpdateOutput 

type AbortEnvironmentUpdateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ApplyEnvironmentManagedActionInput 

type ApplyEnvironmentManagedActionInput struct {

	// The action ID of the scheduled managed action to execute.
	//
	// This member is required.
	ActionId *string

	// The environment ID of the target environment.
	EnvironmentId *string

	// The name of the target environment.
	EnvironmentName *string
	// contains filtered or unexported fields
}

Request to execute a scheduled managed action immediately.

type ApplyEnvironmentManagedActionOutput 

type ApplyEnvironmentManagedActionOutput struct {

	// A description of the managed action.
	ActionDescription *string

	// The action ID of the managed action.
	ActionId *string

	// The type of managed action.
	ActionType types.ActionType

	// The status of the managed action.
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result message containing information about the managed action.

type AssociateEnvironmentOperationsRoleInput 

type AssociateEnvironmentOperationsRoleInput struct {

	// The name of the environment to which to set the operations role.
	//
	// This member is required.
	EnvironmentName *string

	// The Amazon Resource Name (ARN) of an existing IAM role to be used as the
	// environment's operations role.
	//
	// This member is required.
	OperationsRole *string
	// contains filtered or unexported fields
}

Request to add or change the operations role used by an environment.

type AssociateEnvironmentOperationsRoleOutput 

type AssociateEnvironmentOperationsRoleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.19.2 

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 added in v1.19.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CheckDNSAvailabilityInput 

type CheckDNSAvailabilityInput struct {

	// The prefix used when this CNAME is reserved.
	//
	// This member is required.
	CNAMEPrefix *string
	// contains filtered or unexported fields
}

Results message indicating whether a CNAME is available.

type CheckDNSAvailabilityOutput 

type CheckDNSAvailabilityOutput struct {

	// Indicates if the specified CNAME is available:
	//
	//   - true : The CNAME is available.
	//
	//   - false : The CNAME is not available.
	Available *bool

	// The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
	FullyQualifiedCNAME *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Indicates if the specified CNAME is available.

type Client 

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

Client provides the API client to make operations call for AWS Elastic Beanstalk.

func New 

func New(options Options, optFns ...func(*Options)) *Client

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 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AbortEnvironmentUpdate 

func (c *Client) AbortEnvironmentUpdate(ctx context.Context, params *AbortEnvironmentUpdateInput, optFns ...func(*Options)) (*AbortEnvironmentUpdateOutput, error)

Cancels in-progress environment configuration update or application version deployment.

func (*Client) ApplyEnvironmentManagedAction 

func (c *Client) ApplyEnvironmentManagedAction(ctx context.Context, params *ApplyEnvironmentManagedActionInput, optFns ...func(*Options)) (*ApplyEnvironmentManagedActionOutput, error)

Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled . Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

func (*Client) AssociateEnvironmentOperationsRole 

func (c *Client) AssociateEnvironmentOperationsRole(ctx context.Context, params *AssociateEnvironmentOperationsRoleInput, optFns ...func(*Options)) (*AssociateEnvironmentOperationsRoleOutput, error)

Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations rolesin the AWS Elastic Beanstalk Developer Guide.

func (*Client) CheckDNSAvailability 

func (c *Client) CheckDNSAvailability(ctx context.Context, params *CheckDNSAvailabilityInput, optFns ...func(*Options)) (*CheckDNSAvailabilityOutput, error)

Checks if the specified CNAME is available.

func (*Client) ComposeEnvironments 

func (c *Client) ComposeEnvironments(ctx context.Context, params *ComposeEnvironmentsInput, optFns ...func(*Options)) (*ComposeEnvironmentsOutput, error)

Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml . See Compose Environments for details.

func (*Client) CreateApplication 

func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)

Creates an application that has one configuration template named default and no application versions.

func (*Client) CreateApplicationVersion 

func (c *Client) CreateApplicationVersion(ctx context.Context, params *CreateApplicationVersionInput, optFns ...func(*Options)) (*CreateApplicationVersionOutput, error)

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

Specify a commit in an AWS CodeCommit repository with SourceBuildInformation .

Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration .

Specify a source bundle in S3 with SourceBundle

Omit both SourceBuildInformation and SourceBundle to use the default sample application.

After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

func (*Client) CreateConfigurationTemplate 

func (c *Client) CreateConfigurationTemplate(ctx context.Context, params *CreateConfigurationTemplateInput, optFns ...func(*Options)) (*CreateConfigurationTemplateOutput, error)

Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

Templates aren't associated with any environment. The EnvironmentName response element is always null .

DescribeConfigurationOptions

DescribeConfigurationSettings

ListAvailableSolutionStacks

func (*Client) CreateEnvironment 

func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error)

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

func (*Client) CreatePlatformVersion 

func (c *Client) CreatePlatformVersion(ctx context.Context, params *CreatePlatformVersionInput, optFns ...func(*Options)) (*CreatePlatformVersionOutput, error)

Create a new version of your custom platform.

func (*Client) CreateStorageLocation 

func (c *Client) CreateStorageLocation(ctx context.Context, params *CreateStorageLocationInput, optFns ...func(*Options)) (*CreateStorageLocationOutput, error)

Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.

func (*Client) DeleteApplication 

func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

You cannot delete an application that has a running environment.

func (*Client) DeleteApplicationVersion 

func (c *Client) DeleteApplicationVersion(ctx context.Context, params *DeleteApplicationVersionInput, optFns ...func(*Options)) (*DeleteApplicationVersionOutput, error)

Deletes the specified version from the specified application.

You cannot delete an application version that is associated with a running environment.

func (*Client) DeleteConfigurationTemplate 

func (c *Client) DeleteConfigurationTemplate(ctx context.Context, params *DeleteConfigurationTemplateInput, optFns ...func(*Options)) (*DeleteConfigurationTemplateOutput, error)

Deletes the specified configuration template.

When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

func (*Client) DeleteEnvironmentConfiguration 

func (c *Client) DeleteEnvironmentConfiguration(ctx context.Context, params *DeleteEnvironmentConfigurationInput, optFns ...func(*Options)) (*DeleteEnvironmentConfigurationOutput, error)

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettingswhile the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

func (*Client) DeletePlatformVersion 

func (c *Client) DeletePlatformVersion(ctx context.Context, params *DeletePlatformVersionInput, optFns ...func(*Options)) (*DeletePlatformVersionOutput, error)

Deletes the specified version of a custom platform.

func (*Client) DescribeAccountAttributes 

func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error)

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

The result currently has one set of attributes—resource quotas.

func (*Client) DescribeApplicationVersions 

func (c *Client) DescribeApplicationVersions(ctx context.Context, params *DescribeApplicationVersionsInput, optFns ...func(*Options)) (*DescribeApplicationVersionsOutput, error)

Retrieve a list of application versions.

func (*Client) DescribeApplications 

func (c *Client) DescribeApplications(ctx context.Context, params *DescribeApplicationsInput, optFns ...func(*Options)) (*DescribeApplicationsOutput, error)

Returns the descriptions of existing applications.

func (*Client) DescribeConfigurationOptions 

func (c *Client) DescribeConfigurationOptions(ctx context.Context, params *DescribeConfigurationOptionsInput, optFns ...func(*Options)) (*DescribeConfigurationOptionsOutput, error)

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

func (*Client) DescribeConfigurationSettings 

func (c *Client) DescribeConfigurationSettings(ctx context.Context, params *DescribeConfigurationSettingsInput, optFns ...func(*Options)) (*DescribeConfigurationSettingsOutput, error)

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

DeleteEnvironmentConfiguration

func (*Client) DescribeEnvironmentHealth 

func (c *Client) DescribeEnvironmentHealth(ctx context.Context, params *DescribeEnvironmentHealthInput, optFns ...func(*Options)) (*DescribeEnvironmentHealthOutput, error)

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

func (*Client) DescribeEnvironmentManagedActionHistory 

func (c *Client) DescribeEnvironmentManagedActionHistory(ctx context.Context, params *DescribeEnvironmentManagedActionHistoryInput, optFns ...func(*Options)) (*DescribeEnvironmentManagedActionHistoryOutput, error)

Lists an environment's completed and failed managed actions.

func (*Client) DescribeEnvironmentManagedActions 

func (c *Client) DescribeEnvironmentManagedActions(ctx context.Context, params *DescribeEnvironmentManagedActionsInput, optFns ...func(*Options)) (*DescribeEnvironmentManagedActionsOutput, error)

Lists an environment's upcoming and in-progress managed actions.

func (*Client) DescribeEnvironmentResources 

func (c *Client) DescribeEnvironmentResources(ctx context.Context, params *DescribeEnvironmentResourcesInput, optFns ...func(*Options)) (*DescribeEnvironmentResourcesOutput, error)

Returns AWS resources for this environment.

func (*Client) DescribeEnvironments 

func (c *Client) DescribeEnvironments(ctx context.Context, params *DescribeEnvironmentsInput, optFns ...func(*Options)) (*DescribeEnvironmentsOutput, error)

Returns descriptions for existing environments.

func (*Client) DescribeEvents 

func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error)

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken .

func (*Client) DescribeInstancesHealth 

func (c *Client) DescribeInstancesHealth(ctx context.Context, params *DescribeInstancesHealthInput, optFns ...func(*Options)) (*DescribeInstancesHealthOutput, error)

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

func (*Client) DescribePlatformVersion 

func (c *Client) DescribePlatformVersion(ctx context.Context, params *DescribePlatformVersionInput, optFns ...func(*Options)) (*DescribePlatformVersionOutput, error)

Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

func (*Client) DisassociateEnvironmentOperationsRole 

func (c *Client) DisassociateEnvironmentOperationsRole(ctx context.Context, params *DisassociateEnvironmentOperationsRoleInput, optFns ...func(*Options)) (*DisassociateEnvironmentOperationsRoleOutput, error)

Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations rolesin the AWS Elastic Beanstalk Developer Guide.

func (*Client) ListAvailableSolutionStacks 

func (c *Client) ListAvailableSolutionStacks(ctx context.Context, params *ListAvailableSolutionStacksInput, optFns ...func(*Options)) (*ListAvailableSolutionStacksOutput, error)

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

func (*Client) ListPlatformBranches 

func (c *Client) ListPlatformBranches(ctx context.Context, params *ListPlatformBranchesInput, optFns ...func(*Options)) (*ListPlatformBranchesOutput, error)

Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.

For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

func (*Client) ListPlatformVersions 

func (c *Client) ListPlatformVersions(ctx context.Context, params *ListPlatformVersionsInput, optFns ...func(*Options)) (*ListPlatformVersionsOutput, error)

Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

func (*Client) Options added in v1.20.0 

func (c *Client) Options() 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) RebuildEnvironment 

func (c *Client) RebuildEnvironment(ctx context.Context, params *RebuildEnvironmentInput, optFns ...func(*Options)) (*RebuildEnvironmentOutput, error)

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

func (*Client) RequestEnvironmentInfo 

func (c *Client) RequestEnvironmentInfo(ctx context.Context, params *RequestEnvironmentInfoInput, optFns ...func(*Options)) (*RequestEnvironmentInfoOutput, error)

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

RetrieveEnvironmentInfo

func (*Client) RestartAppServer 

func (c *Client) RestartAppServer(ctx context.Context, params *RestartAppServerInput, optFns ...func(*Options)) (*RestartAppServerOutput, error)

Causes the environment to restart the application container server running on each Amazon EC2 instance.

func (*Client) RetrieveEnvironmentInfo 

func (c *Client) RetrieveEnvironmentInfo(ctx context.Context, params *RetrieveEnvironmentInfoInput, optFns ...func(*Options)) (*RetrieveEnvironmentInfoOutput, error)

Retrieves the compiled information from a RequestEnvironmentInfo request.

RequestEnvironmentInfo

func (*Client) SwapEnvironmentCNAMEs 

func (c *Client) SwapEnvironmentCNAMEs(ctx context.Context, params *SwapEnvironmentCNAMEsInput, optFns ...func(*Options)) (*SwapEnvironmentCNAMEsOutput, error)

Swaps the CNAMEs of two environments.

func (*Client) TerminateEnvironment 

func (c *Client) TerminateEnvironment(ctx context.Context, params *TerminateEnvironmentInput, optFns ...func(*Options)) (*TerminateEnvironmentOutput, error)

Terminates the specified environment.

func (*Client) UpdateApplication 

func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)

Updates the specified application to have the specified properties.

If a property (for example, description ) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

func (*Client) UpdateApplicationResourceLifecycle 

func (c *Client) UpdateApplicationResourceLifecycle(ctx context.Context, params *UpdateApplicationResourceLifecycleInput, optFns ...func(*Options)) (*UpdateApplicationResourceLifecycleOutput, error)

Modifies lifecycle settings for an application.

func (*Client) UpdateApplicationVersion 

func (c *Client) UpdateApplicationVersion(ctx context.Context, params *UpdateApplicationVersionInput, optFns ...func(*Options)) (*UpdateApplicationVersionOutput, error)

Updates the specified application version to have the specified properties.

If a property (for example, description ) is not provided, the value remains unchanged. To clear properties, specify an empty string.

func (*Client) UpdateConfigurationTemplate 

func (c *Client) UpdateConfigurationTemplate(ctx context.Context, params *UpdateConfigurationTemplateInput, optFns ...func(*Options)) (*UpdateConfigurationTemplateOutput, error)

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName ) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

DescribeConfigurationOptions

func (*Client) UpdateEnvironment 

func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmentInput, optFns ...func(*Options)) (*UpdateEnvironmentOutput, error)

Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.

When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettingsfor this environment returns two setting descriptions with different DeploymentStatus values.

func (*Client) UpdateTagsForResource 

func (c *Client) UpdateTagsForResource(ctx context.Context, params *UpdateTagsForResourceInput, optFns ...func(*Options)) (*UpdateTagsForResourceOutput, error)

Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove .

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:

elasticbeanstalk:AddTags Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.

elasticbeanstalk:RemoveTags Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.

For details about creating a custom user policy, see Creating a Custom User Policy.

func (*Client) ValidateConfigurationSettings 

func (c *Client) ValidateConfigurationSettings(ctx context.Context, params *ValidateConfigurationSettingsInput, optFns ...func(*Options)) (*ValidateConfigurationSettingsOutput, error)

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

type ComposeEnvironmentsInput 

type ComposeEnvironmentsInput struct {

	// The name of the application to which the specified source bundles belong.
	ApplicationName *string

	// The name of the group to which the target environments belong. Specify a group
	// name only if the environment name defined in each target environment's manifest
	// ends with a + (plus) character. See [Environment Manifest (env.yaml)]for details.
	//
	// [Environment Manifest (env.yaml)]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
	GroupName *string

	// A list of version labels, specifying one or more application source bundles
	// that belong to the target application. Each source bundle must include an
	// environment manifest that specifies the name of the environment and the name of
	// the solution stack to use, and optionally can specify environment links to
	// create.
	VersionLabels []string
	// contains filtered or unexported fields
}

Request to create or update a group of environments.

type ComposeEnvironmentsOutput 

type ComposeEnvironmentsOutput struct {

	//  Returns an EnvironmentDescription list.
	Environments []types.EnvironmentDescription

	// In a paginated request, the token that you can pass in a subsequent request to
	// get the next response page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message containing a list of environment descriptions.

type CreateApplicationInput 

type CreateApplicationInput struct {

	// The name of the application. Must be unique within your account.
	//
	// This member is required.
	ApplicationName *string

	// Your description of the application.
	Description *string

	// Specifies an application resource lifecycle configuration to prevent your
	// application from accumulating too many versions.
	ResourceLifecycleConfig *types.ApplicationResourceLifecycleConfig

	// Specifies the tags applied to the application.
	//
	// Elastic Beanstalk applies these tags only to the application. Environments that
	// you create in the application don't inherit the tags.
	Tags []types.Tag
	// contains filtered or unexported fields
}

Request to create an application.

type CreateApplicationOutput 

type CreateApplicationOutput struct {

	//  The ApplicationDescription of the application.
	Application *types.ApplicationDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message containing a single description of an application.

type CreateApplicationVersionInput 

type CreateApplicationVersionInput struct {

	//  The name of the application. If no application is found with this name, and
	// AutoCreateApplication is false , returns an InvalidParameterValue error.
	//
	// This member is required.
	ApplicationName *string

	// A label identifying this version.
	//
	// Constraint: Must be unique per application. If an application version already
	// exists with this label for the specified application, AWS Elastic Beanstalk
	// returns an InvalidParameterValue error.
	//
	// This member is required.
	VersionLabel *string

	// Set to true to create an application with the specified name if it doesn't
	// already exist.
	AutoCreateApplication *bool

	// Settings for an AWS CodeBuild build.
	BuildConfiguration *types.BuildConfiguration

	// A description of this application version.
	Description *string

	// Pre-processes and validates the environment manifest ( env.yaml ) and
	// configuration files ( *.config files in the .ebextensions folder) in the source
	// bundle. Validating configuration files can identify issues prior to deploying
	// the application version to an environment.
	//
	// You must turn processing on for application versions that you create using AWS
	// CodeBuild or AWS CodeCommit. For application versions built from a source bundle
	// in Amazon S3, processing is optional.
	//
	// The Process option validates Elastic Beanstalk configuration files. It doesn't
	// validate your application's configuration files, like proxy server or Docker
	// configuration.
	Process *bool

	// Specify a commit in an AWS CodeCommit Git repository to use as the source code
	// for the application version.
	SourceBuildInformation *types.SourceBuildInformation

	// The Amazon S3 bucket and key that identify the location of the source bundle
	// for this version.
	//
	// The Amazon S3 bucket must be in the same region as the environment.
	//
	// Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with
	// SourceBuildInformation ), but not both. If neither SourceBundle nor
	// SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.
	SourceBundle *types.S3Location

	// Specifies the tags applied to the application version.
	//
	// Elastic Beanstalk applies these tags only to the application version.
	// Environments that use the application version don't inherit the tags.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateApplicationVersionOutput 

type CreateApplicationVersionOutput struct {

	//  The ApplicationVersionDescription of the application version.
	ApplicationVersion *types.ApplicationVersionDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message wrapping a single description of an application version.

type CreateConfigurationTemplateInput 

type CreateConfigurationTemplateInput struct {

	// The name of the Elastic Beanstalk application to associate with this
	// configuration template.
	//
	// This member is required.
	ApplicationName *string

	// The name of the configuration template.
	//
	// Constraint: This name must be unique per application.
	//
	// This member is required.
	TemplateName *string

	// An optional description for this configuration.
	Description *string

	// The ID of an environment whose settings you want to use to create the
	// configuration template. You must specify EnvironmentId if you don't specify
	// PlatformArn , SolutionStackName , or SourceConfiguration .
	EnvironmentId *string

	// Option values for the Elastic Beanstalk configuration, such as the instance
	// type. If specified, these values override the values obtained from the solution
	// stack or the source configuration template. For a complete list of Elastic
	// Beanstalk configuration options, see [Option Values]in the AWS Elastic Beanstalk Developer
	// Guide.
	//
	// [Option Values]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html
	OptionSettings []types.ConfigurationOptionSetting

	// The Amazon Resource Name (ARN) of the custom platform. For more information,
	// see [Custom Platforms]in the AWS Elastic Beanstalk Developer Guide.
	//
	// If you specify PlatformArn , then don't specify SolutionStackName .
	//
	// [Custom Platforms]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html
	PlatformArn *string

	// The name of an Elastic Beanstalk solution stack (platform version) that this
	// configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7
	// Java 7 . A solution stack specifies the operating system, runtime, and
	// application server for a configuration template. It also determines the set of
	// configuration options as well as the possible and default values. For more
	// information, see [Supported Platforms]in the AWS Elastic Beanstalk Developer Guide.
	//
	// You must specify SolutionStackName if you don't specify PlatformArn ,
	// EnvironmentId , or SourceConfiguration .
	//
	// Use the [ListAvailableSolutionStacks]ListAvailableSolutionStacks API to obtain a list of available solution
	// stacks.
	//
	// [Supported Platforms]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html
	// [ListAvailableSolutionStacks]: https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html
	SolutionStackName *string

	// An Elastic Beanstalk configuration template to base this one on. If specified,
	// Elastic Beanstalk uses the configuration values from the specified configuration
	// template to create a new configuration.
	//
	// Values specified in OptionSettings override any values obtained from the
	// SourceConfiguration .
	//
	// You must specify SourceConfiguration if you don't specify PlatformArn ,
	// EnvironmentId , or SolutionStackName .
	//
	// Constraint: If both solution stack name and source configuration are specified,
	// the solution stack of the source configuration template must match the specified
	// solution stack name.
	SourceConfiguration *types.SourceConfiguration

	// Specifies the tags applied to the configuration template.
	Tags []types.Tag
	// contains filtered or unexported fields
}

Request to create a configuration template.

type CreateConfigurationTemplateOutput 

type CreateConfigurationTemplateOutput struct {

	// The name of the application associated with this configuration set.
	ApplicationName *string

	// The date (in UTC time) when this configuration set was created.
	DateCreated *time.Time

	// The date (in UTC time) when this configuration set was last modified.
	DateUpdated *time.Time

	//  If this configuration set is associated with an environment, the
	// DeploymentStatus parameter indicates the deployment status of this configuration
	// set:
	//
	//   - null : This configuration is not associated with a running environment.
	//
	//   - pending : This is a draft configuration that is not deployed to the
	//   associated environment but is in the process of deploying.
	//
	//   - deployed : This is the configuration that is currently deployed to the
	//   associated running environment.
	//
	//   - failed : This is a draft configuration that failed to successfully deploy.
	DeploymentStatus types.ConfigurationDeploymentStatus

	// Describes this configuration set.
	Description *string

	//  If not null , the name of the environment for this configuration set.
	EnvironmentName *string

	// A list of the configuration options and their values in this configuration set.
	OptionSettings []types.ConfigurationOptionSetting

	// The ARN of the platform version.
	PlatformArn *string

	// The name of the solution stack this configuration set uses.
	SolutionStackName *string

	//  If not null , the name of the configuration template for this configuration
	// set.
	TemplateName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Describes the settings for a configuration set.

type CreateEnvironmentInput 

type CreateEnvironmentInput struct {

	// The name of the application that is associated with this environment.
	//
	// This member is required.
	ApplicationName *string

	// If specified, the environment attempts to use this value as the prefix for the
	// CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is
	// generated automatically by appending a random alphanumeric string to the
	// environment name.
	CNAMEPrefix *string

	// Your description for this environment.
	Description *string

	// A unique name for the environment.
	//
	// Constraint: Must be from 4 to 40 characters in length. The name can contain
	// only letters, numbers, and hyphens. It can't start or end with a hyphen. This
	// name must be unique within a region in your account. If the specified name
	// already exists in the region, Elastic Beanstalk returns an InvalidParameterValue
	// error.
	//
	// If you don't specify the CNAMEPrefix parameter, the environment name becomes
	// part of the CNAME, and therefore part of the visible URL for your application.
	EnvironmentName *string

	// The name of the group to which the target environment belongs. Specify a group
	// name only if the environment's name is specified in an environment manifest and
	// not with the environment name parameter. See [Environment Manifest (env.yaml)]for details.
	//
	// [Environment Manifest (env.yaml)]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
	GroupName *string

	// The Amazon Resource Name (ARN) of an existing IAM role to be used as the
	// environment's operations role. If specified, Elastic Beanstalk uses the
	// operations role for permissions to downstream services during this call and
	// during subsequent calls acting on this environment. To specify an operations
	// role, you must have the iam:PassRole permission for the role. For more
	// information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide.
	//
	// [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html
	OperationsRole *string

	// If specified, AWS Elastic Beanstalk sets the specified configuration options to
	// the requested value in the configuration set for the new environment. These
	// override the values obtained from the solution stack or the configuration
	// template.
	OptionSettings []types.ConfigurationOptionSetting

	// A list of custom user-defined configuration options to remove from the
	// configuration set for this new environment.
	OptionsToRemove []types.OptionSpecification

	// The Amazon Resource Name (ARN) of the custom platform to use with the
	// environment. For more information, see [Custom Platforms]in the AWS Elastic Beanstalk Developer
	// Guide.
	//
	// If you specify PlatformArn , don't specify SolutionStackName .
	//
	// [Custom Platforms]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html
	PlatformArn *string

	// The name of an Elastic Beanstalk solution stack (platform version) to use with
	// the environment. If specified, Elastic Beanstalk sets the configuration values
	// to the default values associated with the specified solution stack. For a list
	// of current solution stacks, see [Elastic Beanstalk Supported Platforms]in the AWS Elastic Beanstalk Platforms guide.
	//
	// If you specify SolutionStackName , don't specify PlatformArn or TemplateName .
	//
	// [Elastic Beanstalk Supported Platforms]: https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html
	SolutionStackName *string

	// Specifies the tags applied to resources in the environment.
	Tags []types.Tag

	// The name of the Elastic Beanstalk configuration template to use with the
	// environment.
	//
	// If you specify TemplateName , then don't specify SolutionStackName .
	TemplateName *string

	// Specifies the tier to use in creating this environment. The environment tier
	// that you choose determines whether Elastic Beanstalk provisions resources to
	// support a web application that handles HTTP(S) requests or a web application
	// that handles background-processing tasks.
	Tier *types.EnvironmentTier

	// The name of the application version to deploy.
	//
	// Default: If not specified, Elastic Beanstalk attempts to deploy the sample
	// application.
	VersionLabel *string
	// contains filtered or unexported fields
}

type CreateEnvironmentOutput 

type CreateEnvironmentOutput struct {

	// Indicates if there is an in-progress environment configuration update or
	// application version deployment that you can cancel.
	//
	// true: There is an update in progress.
	//
	// false: There are no updates currently in progress.
	AbortableOperationInProgress *bool

	// The name of the application associated with this environment.
	ApplicationName *string

	// The URL to the CNAME for this environment.
	CNAME *string

	// The creation date for this environment.
	DateCreated *time.Time

	// The last modified date for this environment.
	DateUpdated *time.Time

	// Describes this environment.
	Description *string

	// For load-balanced, autoscaling environments, the URL to the LoadBalancer. For
	// single-instance environments, the IP address of the instance.
	EndpointURL *string

	// The environment's Amazon Resource Name (ARN), which can be used in other API
	// requests that require an ARN.
	EnvironmentArn *string

	// The ID of this environment.
	EnvironmentId *string

	// A list of links to other environments in the same group.
	EnvironmentLinks []types.EnvironmentLink

	// The name of this environment.
	EnvironmentName *string

	// Describes the health status of the environment. AWS Elastic Beanstalk indicates
	// the failure levels for a running environment:
	//
	//   - Red : Indicates the environment is not responsive. Occurs when three or more
	//   consecutive failures occur for an environment.
	//
	//   - Yellow : Indicates that something is wrong. Occurs when two consecutive
	//   failures occur for an environment.
	//
	//   - Green : Indicates the environment is healthy and fully functional.
	//
	//   - Grey : Default health for a new environment. The environment is not fully
	//   launched and health checks have not started or health checks are suspended
	//   during an UpdateEnvironment or RestartEnvironment request.
	//
	// Default: Grey
	Health types.EnvironmentHealth

	// Returns the health status of the application running in your environment. For
	// more information, see [Health Colors and Statuses].
	//
	// [Health Colors and Statuses]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
	HealthStatus types.EnvironmentHealthStatus

	// The Amazon Resource Name (ARN) of the environment's operations role. For more
	// information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide.
	//
	// [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html
	OperationsRole *string

	// The ARN of the platform version.
	PlatformArn *string

	// The description of the AWS resources used by this environment.
	Resources *types.EnvironmentResourcesDescription

	//  The name of the SolutionStack deployed with this environment.
	SolutionStackName *string

	// The current operational status of the environment:
	//
	//   - Launching : Environment is in the process of initial deployment.
	//
	//   - Updating : Environment is in the process of updating its configuration
	//   settings or application version.
	//
	//   - Ready : Environment is available to have an action performed on it, such as
	//   update or terminate.
	//
	//   - Terminating : Environment is in the shut-down process.
	//
	//   - Terminated : Environment is not running.
	Status types.EnvironmentStatus

	// The name of the configuration template used to originally launch this
	// environment.
	TemplateName *string

	// Describes the current tier of this environment.
	Tier *types.EnvironmentTier

	// The application version deployed in this environment.
	VersionLabel *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Describes the properties of an environment.

type CreatePlatformVersionInput 

type CreatePlatformVersionInput struct {

	// The location of the platform definition archive in Amazon S3.
	//
	// This member is required.
	PlatformDefinitionBundle *types.S3Location

	// The name of your custom platform.
	//
	// This member is required.
	PlatformName *string

	// The number, such as 1.0.2, for the new platform version.
	//
	// This member is required.
	PlatformVersion *string

	// The name of the builder environment.
	EnvironmentName *string

	// The configuration option settings to apply to the builder environment.
	OptionSettings []types.ConfigurationOptionSetting

	// Specifies the tags applied to the new platform version.
	//
	// Elastic Beanstalk applies these tags only to the platform version. Environments
	// that you create using the platform version don't inherit the tags.
	Tags []types.Tag
	// contains filtered or unexported fields
}

Request to create a new platform version.

type CreatePlatformVersionOutput 

type CreatePlatformVersionOutput struct {

	// The builder used to create the custom platform.
	Builder *types.Builder

	// Detailed information about the new version of the custom platform.
	PlatformSummary *types.PlatformSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateStorageLocationInput 

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

type CreateStorageLocationOutput 

type CreateStorageLocationOutput struct {

	// The name of the Amazon S3 bucket created.
	S3Bucket *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Results of a CreateStorageLocationResult call.

type DeleteApplicationInput 

type DeleteApplicationInput struct {

	// The name of the application to delete.
	//
	// This member is required.
	ApplicationName *string

	// When set to true, running environments will be terminated before deleting the
	// application.
	TerminateEnvByForce *bool
	// contains filtered or unexported fields
}

Request to delete an application.

type DeleteApplicationOutput 

type DeleteApplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteApplicationVersionInput 

type DeleteApplicationVersionInput struct {

	// The name of the application to which the version belongs.
	//
	// This member is required.
	ApplicationName *string

	// The label of the version to delete.
	//
	// This member is required.
	VersionLabel *string

	// Set to true to delete the source bundle from your storage bucket. Otherwise,
	// the application version is deleted only from Elastic Beanstalk and the source
	// bundle remains in Amazon S3.
	DeleteSourceBundle *bool
	// contains filtered or unexported fields
}

Request to delete an application version.

type DeleteApplicationVersionOutput 

type DeleteApplicationVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteConfigurationTemplateInput 

type DeleteConfigurationTemplateInput struct {

	// The name of the application to delete the configuration template from.
	//
	// This member is required.
	ApplicationName *string

	// The name of the configuration template to delete.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

Request to delete a configuration template.

type DeleteConfigurationTemplateOutput 

type DeleteConfigurationTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEnvironmentConfigurationInput 

type DeleteEnvironmentConfigurationInput struct {

	// The name of the application the environment is associated with.
	//
	// This member is required.
	ApplicationName *string

	// The name of the environment to delete the draft configuration from.
	//
	// This member is required.
	EnvironmentName *string
	// contains filtered or unexported fields
}

Request to delete a draft environment configuration.

type DeleteEnvironmentConfigurationOutput 

type DeleteEnvironmentConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePlatformVersionInput 

type DeletePlatformVersionInput struct {

	// The ARN of the version of the custom platform.
	PlatformArn *string
	// contains filtered or unexported fields
}

type DeletePlatformVersionOutput 

type DeletePlatformVersionOutput struct {

	// Detailed information about the version of the custom platform.
	PlatformSummary *types.PlatformSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAccountAttributesInput 

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

type DescribeAccountAttributesOutput 

type DescribeAccountAttributesOutput struct {

	// The Elastic Beanstalk resource quotas associated with the calling AWS account.
	ResourceQuotas *types.ResourceQuotas

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeApplicationVersionsInput 

type DescribeApplicationVersionsInput struct {

	// Specify an application name to show only application versions for that
	// application.
	ApplicationName *string

	// For a paginated request. Specify a maximum number of application versions to
	// include in each response.
	//
	// If no MaxRecords is specified, all available application versions are retrieved
	// in a single response.
	MaxRecords *int32

	// For a paginated request. Specify a token from a previous response page to
	// retrieve the next response page. All other parameter values must be identical to
	// the ones specified in the initial request.
	//
	// If no NextToken is specified, the first page is retrieved.
	NextToken *string

	// Specify a version label to show a specific application version.
	VersionLabels []string
	// contains filtered or unexported fields
}

Request to describe application versions.

type DescribeApplicationVersionsOutput 

type DescribeApplicationVersionsOutput struct {

	// List of ApplicationVersionDescription objects sorted in order of creation.
	ApplicationVersions []types.ApplicationVersionDescription

	// In a paginated request, the token that you can pass in a subsequent request to
	// get the next response page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message wrapping a list of application version descriptions.

type DescribeApplicationsInput 

type DescribeApplicationsInput struct {

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to only
	// include those with the specified names.
	ApplicationNames []string
	// contains filtered or unexported fields
}

Request to describe one or more applications.

type DescribeApplicationsOutput 

type DescribeApplicationsOutput struct {

	// This parameter contains a list of ApplicationDescription.
	Applications []types.ApplicationDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message containing a list of application descriptions.

type DescribeConfigurationOptionsInput 

type DescribeConfigurationOptionsInput struct {

	// The name of the application associated with the configuration template or
	// environment. Only needed if you want to describe the configuration options
	// associated with either the configuration template or environment.
	ApplicationName *string

	// The name of the environment whose configuration options you want to describe.
	EnvironmentName *string

	// If specified, restricts the descriptions to only the specified options.
	Options []types.OptionSpecification

	// The ARN of the custom platform.
	PlatformArn *string

	// The name of the solution stack whose configuration options you want to describe.
	SolutionStackName *string

	// The name of the configuration template whose configuration options you want to
	// describe.
	TemplateName *string
	// contains filtered or unexported fields
}

Result message containing a list of application version descriptions.

type DescribeConfigurationOptionsOutput 

type DescribeConfigurationOptionsOutput struct {

	//  A list of ConfigurationOptionDescription.
	Options []types.ConfigurationOptionDescription

	// The ARN of the platform version.
	PlatformArn *string

	// The name of the solution stack these configuration options belong to.
	SolutionStackName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Describes the settings for a specified configuration set.

type DescribeConfigurationSettingsInput 

type DescribeConfigurationSettingsInput struct {

	// The application for the environment or configuration template.
	//
	// This member is required.
	ApplicationName *string

	// The name of the environment to describe.
	//
	// Condition: You must specify either this or a TemplateName, but not both. If you
	// specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
	// error. If you do not specify either, AWS Elastic Beanstalk returns
	// MissingRequiredParameter error.
	EnvironmentName *string

	// The name of the configuration template to describe.
	//
	// Conditional: You must specify either this parameter or an EnvironmentName, but
	// not both. If you specify both, AWS Elastic Beanstalk returns an
	// InvalidParameterCombination error. If you do not specify either, AWS Elastic
	// Beanstalk returns a MissingRequiredParameter error.
	TemplateName *string
	// contains filtered or unexported fields
}

Result message containing all of the configuration settings for a specified solution stack or configuration template.

type DescribeConfigurationSettingsOutput 

type DescribeConfigurationSettingsOutput struct {

	//  A list of ConfigurationSettingsDescription.
	ConfigurationSettings []types.ConfigurationSettingsDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The results from a request to change the configuration settings of an environment.

type DescribeEnvironmentHealthInput 

type DescribeEnvironmentHealthInput struct {

	// Specify the response elements to return. To retrieve all attributes, set to All
	// . If no attribute names are specified, returns the name of the environment.
	AttributeNames []types.EnvironmentHealthAttribute

	// Specify the environment by ID.
	//
	// You must specify either this or an EnvironmentName, or both.
	EnvironmentId *string

	// Specify the environment by name.
	//
	// You must specify either this or an EnvironmentName, or both.
	EnvironmentName *string
	// contains filtered or unexported fields
}

See the example below to learn how to create a request body.

type DescribeEnvironmentHealthOutput 

type DescribeEnvironmentHealthOutput struct {

	// Application request metrics for the environment.
	ApplicationMetrics *types.ApplicationMetrics

	// Descriptions of the data that contributed to the environment's current health
	// status.
	Causes []string

	// The [health color] of the environment.
	//
	// [health color]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
	Color *string

	// The environment's name.
	EnvironmentName *string

	// The [health status] of the environment. For example, Ok .
	//
	// [health status]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
	HealthStatus *string

	// Summary health information for the instances in the environment.
	InstancesHealth *types.InstanceHealthSummary

	// The date and time that the health information was retrieved.
	RefreshedAt *time.Time

	// The environment's operational status. Ready , Launching , Updating , Terminating
	// , or Terminated .
	Status types.EnvironmentHealth

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Health details for an AWS Elastic Beanstalk environment.

type DescribeEnvironmentManagedActionHistoryAPIClient added in v0.30.0 

type DescribeEnvironmentManagedActionHistoryAPIClient interface {
	DescribeEnvironmentManagedActionHistory(context.Context, *DescribeEnvironmentManagedActionHistoryInput, ...func(*Options)) (*DescribeEnvironmentManagedActionHistoryOutput, error)
}

DescribeEnvironmentManagedActionHistoryAPIClient is a client that implements the DescribeEnvironmentManagedActionHistory operation.

type DescribeEnvironmentManagedActionHistoryInput 

type DescribeEnvironmentManagedActionHistoryInput struct {

	// The environment ID of the target environment.
	EnvironmentId *string

	// The name of the target environment.
	EnvironmentName *string

	// The maximum number of items to return for a single request.
	MaxItems *int32

	// The pagination token returned by a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

Request to list completed and failed managed actions.

type DescribeEnvironmentManagedActionHistoryOutput 

type DescribeEnvironmentManagedActionHistoryOutput struct {

	// A list of completed and failed managed actions.
	ManagedActionHistoryItems []types.ManagedActionHistoryItem

	// A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A result message containing a list of completed and failed managed actions.

type DescribeEnvironmentManagedActionHistoryPaginator added in v0.30.0 

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

DescribeEnvironmentManagedActionHistoryPaginator is a paginator for DescribeEnvironmentManagedActionHistory

func NewDescribeEnvironmentManagedActionHistoryPaginator added in v0.30.0 

func NewDescribeEnvironmentManagedActionHistoryPaginator(client DescribeEnvironmentManagedActionHistoryAPIClient, params *DescribeEnvironmentManagedActionHistoryInput, optFns ...func(*DescribeEnvironmentManagedActionHistoryPaginatorOptions)) *DescribeEnvironmentManagedActionHistoryPaginator

NewDescribeEnvironmentManagedActionHistoryPaginator returns a new DescribeEnvironmentManagedActionHistoryPaginator

func (*DescribeEnvironmentManagedActionHistoryPaginator) HasMorePages added in v0.30.0 

func (p *DescribeEnvironmentManagedActionHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeEnvironmentManagedActionHistoryPaginator) NextPage added in v0.30.0 

func (p *DescribeEnvironmentManagedActionHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEnvironmentManagedActionHistoryOutput, error)

NextPage retrieves the next DescribeEnvironmentManagedActionHistory page.

type DescribeEnvironmentManagedActionHistoryPaginatorOptions added in v0.30.0 

type DescribeEnvironmentManagedActionHistoryPaginatorOptions struct {
	// The maximum number of items to return for a single request.
	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
}

DescribeEnvironmentManagedActionHistoryPaginatorOptions is the paginator options for DescribeEnvironmentManagedActionHistory

type DescribeEnvironmentManagedActionsInput 

type DescribeEnvironmentManagedActionsInput struct {

	// The environment ID of the target environment.
	EnvironmentId *string

	// The name of the target environment.
	EnvironmentName *string

	// To show only actions with a particular status, specify a status.
	Status types.ActionStatus
	// contains filtered or unexported fields
}

Request to list an environment's upcoming and in-progress managed actions.

type DescribeEnvironmentManagedActionsOutput 

type DescribeEnvironmentManagedActionsOutput struct {

	// A list of upcoming and in-progress managed actions.
	ManagedActions []types.ManagedAction

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result message containing a list of managed actions.

type DescribeEnvironmentResourcesInput 

type DescribeEnvironmentResourcesInput struct {

	// The ID of the environment to retrieve AWS resource usage data.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If you
	// do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string

	// The name of the environment to retrieve AWS resource usage data.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If you do
	// not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string
	// contains filtered or unexported fields
}

Request to describe the resources in an environment.

type DescribeEnvironmentResourcesOutput 

type DescribeEnvironmentResourcesOutput struct {

	//  A list of EnvironmentResourceDescription.
	EnvironmentResources *types.EnvironmentResourceDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message containing a list of environment resource descriptions.

type DescribeEnvironmentsAPIClient added in v0.31.0 

type DescribeEnvironmentsAPIClient interface {
	DescribeEnvironments(context.Context, *DescribeEnvironmentsInput, ...func(*Options)) (*DescribeEnvironmentsOutput, error)
}

DescribeEnvironmentsAPIClient is a client that implements the DescribeEnvironments operation.

type DescribeEnvironmentsInput 

type DescribeEnvironmentsInput struct {

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those that are associated with this application.
	ApplicationName *string

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those that have the specified IDs.
	EnvironmentIds []string

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those that have the specified names.
	EnvironmentNames []string

	// Indicates whether to include deleted environments:
	//
	// true : Environments that have been deleted after IncludedDeletedBackTo are
	// displayed.
	//
	// false : Do not include deleted environments.
	IncludeDeleted *bool

	//  If specified when IncludeDeleted is set to true , then environments deleted
	// after this date are displayed.
	IncludedDeletedBackTo *time.Time

	// For a paginated request. Specify a maximum number of environments to include in
	// each response.
	//
	// If no MaxRecords is specified, all available environments are retrieved in a
	// single response.
	MaxRecords *int32

	// For a paginated request. Specify a token from a previous response page to
	// retrieve the next response page. All other parameter values must be identical to
	// the ones specified in the initial request.
	//
	// If no NextToken is specified, the first page is retrieved.
	NextToken *string

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those that are associated with this application version.
	VersionLabel *string
	// contains filtered or unexported fields
}

Request to describe one or more environments.

type DescribeEnvironmentsOutput 

type DescribeEnvironmentsOutput struct {

	//  Returns an EnvironmentDescription list.
	Environments []types.EnvironmentDescription

	// In a paginated request, the token that you can pass in a subsequent request to
	// get the next response page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message containing a list of environment descriptions.

type DescribeEventsAPIClient added in v0.30.0 

type DescribeEventsAPIClient interface {
	DescribeEvents(context.Context, *DescribeEventsInput, ...func(*Options)) (*DescribeEventsOutput, error)
}

DescribeEventsAPIClient is a client that implements the DescribeEvents operation.

type DescribeEventsInput 

type DescribeEventsInput struct {

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those associated with this application.
	ApplicationName *string

	//  If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those that occur up to, but not including, the EndTime .
	EndTime *time.Time

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those associated with this environment.
	EnvironmentId *string

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those associated with this environment.
	EnvironmentName *string

	// Specifies the maximum number of events that can be returned, beginning with the
	// most recent event.
	MaxRecords *int32

	// Pagination token. If specified, the events return the next batch of results.
	NextToken *string

	// The ARN of a custom platform version. If specified, AWS Elastic Beanstalk
	// restricts the returned descriptions to those associated with this custom
	// platform version.
	PlatformArn *string

	// If specified, AWS Elastic Beanstalk restricts the described events to include
	// only those associated with this request ID.
	RequestId *string

	// If specified, limits the events returned from this call to include only those
	// with the specified severity or higher.
	Severity types.EventSeverity

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those that occur on or after this time.
	StartTime *time.Time

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those that are associated with this environment configuration.
	TemplateName *string

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those associated with this application version.
	VersionLabel *string
	// contains filtered or unexported fields
}

Request to retrieve a list of events for an environment.

type DescribeEventsOutput 

type DescribeEventsOutput struct {

	//  A list of EventDescription.
	Events []types.EventDescription

	//  If returned, this indicates that there are more results to obtain. Use this
	// token in the next DescribeEventscall to get the next batch of events.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message wrapping a list of event descriptions.

type DescribeEventsPaginator added in v0.30.0 

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

DescribeEventsPaginator is a paginator for DescribeEvents

func NewDescribeEventsPaginator added in v0.30.0 

func NewDescribeEventsPaginator(client DescribeEventsAPIClient, params *DescribeEventsInput, optFns ...func(*DescribeEventsPaginatorOptions)) *DescribeEventsPaginator

NewDescribeEventsPaginator returns a new DescribeEventsPaginator

func (*DescribeEventsPaginator) HasMorePages added in v0.30.0 

func (p *DescribeEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeEventsPaginator) NextPage added in v0.30.0 

func (p *DescribeEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEventsOutput, error)

NextPage retrieves the next DescribeEvents page.

type DescribeEventsPaginatorOptions added in v0.30.0 

type DescribeEventsPaginatorOptions struct {
	// Specifies the maximum number of events that can be returned, beginning with the
	// most recent event.
	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
}

DescribeEventsPaginatorOptions is the paginator options for DescribeEvents

type DescribeInstancesHealthInput 

type DescribeInstancesHealthInput struct {

	// Specifies the response elements you wish to receive. To retrieve all
	// attributes, set to All . If no attribute names are specified, returns a list of
	// instances.
	AttributeNames []types.InstancesHealthAttribute

	// Specify the AWS Elastic Beanstalk environment by ID.
	EnvironmentId *string

	// Specify the AWS Elastic Beanstalk environment by name.
	EnvironmentName *string

	// Specify the pagination token returned by a previous call.
	NextToken *string
	// contains filtered or unexported fields
}

Parameters for a call to DescribeInstancesHealth .

type DescribeInstancesHealthOutput 

type DescribeInstancesHealthOutput struct {

	// Detailed health information about each instance.
	//
	// The output differs slightly between Linux and Windows environments. There is a
	// difference in the members that are supported under the type.
	InstanceHealthList []types.SingleInstanceHealth

	// Pagination token for the next page of results, if available.
	NextToken *string

	// The date and time that the health information was retrieved.
	RefreshedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

type DescribePlatformVersionInput 

type DescribePlatformVersionInput struct {

	// The ARN of the platform version.
	PlatformArn *string
	// contains filtered or unexported fields
}

type DescribePlatformVersionOutput 

type DescribePlatformVersionOutput struct {

	// Detailed information about the platform version.
	PlatformDescription *types.PlatformDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateEnvironmentOperationsRoleInput 

type DisassociateEnvironmentOperationsRoleInput struct {

	// The name of the environment from which to disassociate the operations role.
	//
	// This member is required.
	EnvironmentName *string
	// contains filtered or unexported fields
}

Request to disassociate the operations role from an environment.

type DisassociateEnvironmentOperationsRoleOutput 

type DisassociateEnvironmentOperationsRoleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.16.0 

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 added in v1.16.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.16.0 

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 added in v1.1.0 

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 added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.16.0 

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 added in v1.16.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type EnvironmentExistsWaiter added in v0.31.0 

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

EnvironmentExistsWaiter defines the waiters for EnvironmentExists

func NewEnvironmentExistsWaiter added in v0.31.0 

func NewEnvironmentExistsWaiter(client DescribeEnvironmentsAPIClient, optFns ...func(*EnvironmentExistsWaiterOptions)) *EnvironmentExistsWaiter

NewEnvironmentExistsWaiter constructs a EnvironmentExistsWaiter.

func (*EnvironmentExistsWaiter) Wait added in v0.31.0 

func (w *EnvironmentExistsWaiter) Wait(ctx context.Context, params *DescribeEnvironmentsInput, maxWaitDur time.Duration, optFns ...func(*EnvironmentExistsWaiterOptions)) error

Wait calls the waiter function for EnvironmentExists waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*EnvironmentExistsWaiter) WaitForOutput added in v1.9.0 

func (w *EnvironmentExistsWaiter) WaitForOutput(ctx context.Context, params *DescribeEnvironmentsInput, maxWaitDur time.Duration, optFns ...func(*EnvironmentExistsWaiterOptions)) (*DescribeEnvironmentsOutput, error)

WaitForOutput calls the waiter function for EnvironmentExists waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type EnvironmentExistsWaiterOptions added in v0.31.0 

type EnvironmentExistsWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// EnvironmentExistsWaiter will use default minimum delay of 20 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, EnvironmentExistsWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeEnvironmentsInput, *DescribeEnvironmentsOutput, error) (bool, error)
}

EnvironmentExistsWaiterOptions are waiter options for EnvironmentExistsWaiter

type EnvironmentTerminatedWaiter added in v0.31.0 

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

EnvironmentTerminatedWaiter defines the waiters for EnvironmentTerminated

func NewEnvironmentTerminatedWaiter added in v0.31.0 

func NewEnvironmentTerminatedWaiter(client DescribeEnvironmentsAPIClient, optFns ...func(*EnvironmentTerminatedWaiterOptions)) *EnvironmentTerminatedWaiter

NewEnvironmentTerminatedWaiter constructs a EnvironmentTerminatedWaiter.

func (*EnvironmentTerminatedWaiter) Wait added in v0.31.0 

func (w *EnvironmentTerminatedWaiter) Wait(ctx context.Context, params *DescribeEnvironmentsInput, maxWaitDur time.Duration, optFns ...func(*EnvironmentTerminatedWaiterOptions)) error

Wait calls the waiter function for EnvironmentTerminated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*EnvironmentTerminatedWaiter) WaitForOutput added in v1.9.0 

func (w *EnvironmentTerminatedWaiter) WaitForOutput(ctx context.Context, params *DescribeEnvironmentsInput, maxWaitDur time.Duration, optFns ...func(*EnvironmentTerminatedWaiterOptions)) (*DescribeEnvironmentsOutput, error)

WaitForOutput calls the waiter function for EnvironmentTerminated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type EnvironmentTerminatedWaiterOptions added in v0.31.0 

type EnvironmentTerminatedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// EnvironmentTerminatedWaiter will use default minimum delay of 20 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, EnvironmentTerminatedWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeEnvironmentsInput, *DescribeEnvironmentsOutput, error) (bool, error)
}

EnvironmentTerminatedWaiterOptions are waiter options for EnvironmentTerminatedWaiter

type EnvironmentUpdatedWaiter added in v0.31.0 

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

EnvironmentUpdatedWaiter defines the waiters for EnvironmentUpdated

func NewEnvironmentUpdatedWaiter added in v0.31.0 

func NewEnvironmentUpdatedWaiter(client DescribeEnvironmentsAPIClient, optFns ...func(*EnvironmentUpdatedWaiterOptions)) *EnvironmentUpdatedWaiter

NewEnvironmentUpdatedWaiter constructs a EnvironmentUpdatedWaiter.

func (*EnvironmentUpdatedWaiter) Wait added in v0.31.0 

func (w *EnvironmentUpdatedWaiter) Wait(ctx context.Context, params *DescribeEnvironmentsInput, maxWaitDur time.Duration, optFns ...func(*EnvironmentUpdatedWaiterOptions)) error

Wait calls the waiter function for EnvironmentUpdated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*EnvironmentUpdatedWaiter) WaitForOutput added in v1.9.0 

func (w *EnvironmentUpdatedWaiter) WaitForOutput(ctx context.Context, params *DescribeEnvironmentsInput, maxWaitDur time.Duration, optFns ...func(*EnvironmentUpdatedWaiterOptions)) (*DescribeEnvironmentsOutput, error)

WaitForOutput calls the waiter function for EnvironmentUpdated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type EnvironmentUpdatedWaiterOptions added in v0.31.0 

type EnvironmentUpdatedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// EnvironmentUpdatedWaiter will use default minimum delay of 20 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, EnvironmentUpdatedWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeEnvironmentsInput, *DescribeEnvironmentsOutput, error) (bool, error)
}

EnvironmentUpdatedWaiterOptions are waiter options for EnvironmentUpdatedWaiter

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAvailableSolutionStacksInput 

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

type ListAvailableSolutionStacksOutput 

type ListAvailableSolutionStacksOutput struct {

	//  A list of available solution stacks and their SolutionStackDescription.
	SolutionStackDetails []types.SolutionStackDescription

	// A list of available solution stacks.
	SolutionStacks []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A list of available AWS Elastic Beanstalk solution stacks.

type ListPlatformBranchesAPIClient added in v0.30.0 

type ListPlatformBranchesAPIClient interface {
	ListPlatformBranches(context.Context, *ListPlatformBranchesInput, ...func(*Options)) (*ListPlatformBranchesOutput, error)
}

ListPlatformBranchesAPIClient is a client that implements the ListPlatformBranches operation.

type ListPlatformBranchesInput 

type ListPlatformBranchesInput struct {

	// Criteria for restricting the resulting list of platform branches. The filter is
	// evaluated as a logical conjunction (AND) of the separate SearchFilter terms.
	//
	// The following list shows valid attribute values for each of the SearchFilter
	// terms. Most operators take a single value. The in and not_in operators can take
	// multiple values.
	//
	//   - Attribute = BranchName :
	//
	//   - Operator : = | != | begins_with | ends_with | contains | in | not_in
	//
	//   - Attribute = LifecycleState :
	//
	//   - Operator : = | != | in | not_in
	//
	//   - Values : beta | supported | deprecated | retired
	//
	//   - Attribute = PlatformName :
	//
	//   - Operator : = | != | begins_with | ends_with | contains | in | not_in
	//
	//   - Attribute = TierType :
	//
	//   - Operator : = | !=
	//
	//   - Values : WebServer/Standard | Worker/SQS/HTTP
	//
	// Array size: limited to 10 SearchFilter objects.
	//
	// Within each SearchFilter item, the Values array is limited to 10 items.
	Filters []types.SearchFilter

	// The maximum number of platform branch values returned in one call.
	MaxRecords *int32

	// For a paginated request. Specify a token from a previous response page to
	// retrieve the next response page. All other parameter values must be identical to
	// the ones specified in the initial request.
	//
	// If no NextToken is specified, the first page is retrieved.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPlatformBranchesOutput 

type ListPlatformBranchesOutput struct {

	// In a paginated request, if this value isn't null , it's the token that you can
	// pass in a subsequent request to get the next response page.
	NextToken *string

	// Summary information about the platform branches.
	PlatformBranchSummaryList []types.PlatformBranchSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPlatformBranchesPaginator added in v0.30.0 

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

ListPlatformBranchesPaginator is a paginator for ListPlatformBranches

func NewListPlatformBranchesPaginator added in v0.30.0 

func NewListPlatformBranchesPaginator(client ListPlatformBranchesAPIClient, params *ListPlatformBranchesInput, optFns ...func(*ListPlatformBranchesPaginatorOptions)) *ListPlatformBranchesPaginator

NewListPlatformBranchesPaginator returns a new ListPlatformBranchesPaginator

func (*ListPlatformBranchesPaginator) HasMorePages added in v0.30.0 

func (p *ListPlatformBranchesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPlatformBranchesPaginator) NextPage added in v0.30.0 

func (p *ListPlatformBranchesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPlatformBranchesOutput, error)

NextPage retrieves the next ListPlatformBranches page.

type ListPlatformBranchesPaginatorOptions added in v0.30.0 

type ListPlatformBranchesPaginatorOptions struct {
	// The maximum number of platform branch values returned in one call.
	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
}

ListPlatformBranchesPaginatorOptions is the paginator options for ListPlatformBranches

type ListPlatformVersionsAPIClient added in v0.30.0 

type ListPlatformVersionsAPIClient interface {
	ListPlatformVersions(context.Context, *ListPlatformVersionsInput, ...func(*Options)) (*ListPlatformVersionsOutput, error)
}

ListPlatformVersionsAPIClient is a client that implements the ListPlatformVersions operation.

type ListPlatformVersionsInput 

type ListPlatformVersionsInput struct {

	// Criteria for restricting the resulting list of platform versions. The filter is
	// interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.
	Filters []types.PlatformFilter

	// The maximum number of platform version values returned in one call.
	MaxRecords *int32

	// For a paginated request. Specify a token from a previous response page to
	// retrieve the next response page. All other parameter values must be identical to
	// the ones specified in the initial request.
	//
	// If no NextToken is specified, the first page is retrieved.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPlatformVersionsOutput 

type ListPlatformVersionsOutput struct {

	// In a paginated request, if this value isn't null , it's the token that you can
	// pass in a subsequent request to get the next response page.
	NextToken *string

	// Summary information about the platform versions.
	PlatformSummaryList []types.PlatformSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPlatformVersionsPaginator added in v0.30.0 

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

ListPlatformVersionsPaginator is a paginator for ListPlatformVersions

func NewListPlatformVersionsPaginator added in v0.30.0 

func NewListPlatformVersionsPaginator(client ListPlatformVersionsAPIClient, params *ListPlatformVersionsInput, optFns ...func(*ListPlatformVersionsPaginatorOptions)) *ListPlatformVersionsPaginator

NewListPlatformVersionsPaginator returns a new ListPlatformVersionsPaginator

func (*ListPlatformVersionsPaginator) HasMorePages added in v0.30.0 

func (p *ListPlatformVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPlatformVersionsPaginator) NextPage added in v0.30.0 

func (p *ListPlatformVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPlatformVersionsOutput, error)

NextPage retrieves the next ListPlatformVersions page.

type ListPlatformVersionsPaginatorOptions added in v0.30.0 

type ListPlatformVersionsPaginatorOptions struct {
	// The maximum number of platform version values returned in one call.
	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
}

ListPlatformVersionsPaginatorOptions is the paginator options for ListPlatformVersions

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.
	//
	// Must be the ARN of an Elastic Beanstalk resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resource for which a tag list was
	// requested.
	ResourceArn *string

	// A list of tag key-value pairs.
	ResourceTags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 client meter provider.
	MeterProvider metrics.MeterProvider

	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

	// 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 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.19.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type RebuildEnvironmentInput 

type RebuildEnvironmentInput struct {

	// The ID of the environment to rebuild.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If you
	// do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string

	// The name of the environment to rebuild.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If you do
	// not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string
	// contains filtered or unexported fields
}

type RebuildEnvironmentOutput 

type RebuildEnvironmentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RequestEnvironmentInfoInput 

type RequestEnvironmentInfoInput struct {

	// The type of information to request.
	//
	// This member is required.
	InfoType types.EnvironmentInfoType

	// The ID of the environment of the requested data.
	//
	// If no such environment is found, RequestEnvironmentInfo returns an
	// InvalidParameterValue error.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If you
	// do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string

	// The name of the environment of the requested data.
	//
	// If no such environment is found, RequestEnvironmentInfo returns an
	// InvalidParameterValue error.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If you do
	// not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string
	// contains filtered or unexported fields
}

Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.

type RequestEnvironmentInfoOutput 

type RequestEnvironmentInfoOutput struct {
	// 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 RestartAppServerInput 

type RestartAppServerInput struct {

	// The ID of the environment to restart the server for.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If you
	// do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string

	// The name of the environment to restart the server for.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If you do
	// not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string
	// contains filtered or unexported fields
}

type RestartAppServerOutput 

type RestartAppServerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RetrieveEnvironmentInfoInput 

type RetrieveEnvironmentInfoInput struct {

	// The type of information to retrieve.
	//
	// This member is required.
	InfoType types.EnvironmentInfoType

	// The ID of the data's environment.
	//
	// If no such environment is found, returns an InvalidParameterValue error.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If you
	// do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string

	// The name of the data's environment.
	//
	// If no such environment is found, returns an InvalidParameterValue error.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If you do
	// not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string
	// contains filtered or unexported fields
}

Request to download logs retrieved with RequestEnvironmentInfo.

type RetrieveEnvironmentInfoOutput 

type RetrieveEnvironmentInfoOutput struct {

	//  The EnvironmentInfoDescription of the environment.
	EnvironmentInfo []types.EnvironmentInfoDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message containing a description of the requested environment info.

type SwapEnvironmentCNAMEsInput 

type SwapEnvironmentCNAMEsInput struct {

	// The ID of the destination environment.
	//
	// Condition: You must specify at least the DestinationEnvironmentID or the
	// DestinationEnvironmentName . You may also specify both. You must specify the
	// SourceEnvironmentId with the DestinationEnvironmentId .
	DestinationEnvironmentId *string

	// The name of the destination environment.
	//
	// Condition: You must specify at least the DestinationEnvironmentID or the
	// DestinationEnvironmentName . You may also specify both. You must specify the
	// SourceEnvironmentName with the DestinationEnvironmentName .
	DestinationEnvironmentName *string

	// The ID of the source environment.
	//
	// Condition: You must specify at least the SourceEnvironmentID or the
	// SourceEnvironmentName . You may also specify both. If you specify the
	// SourceEnvironmentId , you must specify the DestinationEnvironmentId .
	SourceEnvironmentId *string

	// The name of the source environment.
	//
	// Condition: You must specify at least the SourceEnvironmentID or the
	// SourceEnvironmentName . You may also specify both. If you specify the
	// SourceEnvironmentName , you must specify the DestinationEnvironmentName .
	SourceEnvironmentName *string
	// contains filtered or unexported fields
}

Swaps the CNAMEs of two environments.

type SwapEnvironmentCNAMEsOutput 

type SwapEnvironmentCNAMEsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TerminateEnvironmentInput 

type TerminateEnvironmentInput struct {

	// The ID of the environment to terminate.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If you
	// do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string

	// The name of the environment to terminate.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If you do
	// not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string

	// Terminates the target environment even if another environment in the same group
	// is dependent on it.
	ForceTerminate *bool

	// Indicates whether the associated AWS resources should shut down when the
	// environment is terminated:
	//
	//   - true : The specified environment as well as the associated AWS resources,
	//   such as Auto Scaling group and LoadBalancer, are terminated.
	//
	//   - false : AWS Elastic Beanstalk resource management is removed from the
	//   environment, but the AWS resources continue to operate.
	//
	// For more information, see the [AWS Elastic Beanstalk User Guide.]
	//
	// Default: true
	//
	// Valid Values: true | false
	//
	// [AWS Elastic Beanstalk User Guide.]: https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/
	TerminateResources *bool
	// contains filtered or unexported fields
}

Request to terminate an environment.

type TerminateEnvironmentOutput 

type TerminateEnvironmentOutput struct {

	// Indicates if there is an in-progress environment configuration update or
	// application version deployment that you can cancel.
	//
	// true: There is an update in progress.
	//
	// false: There are no updates currently in progress.
	AbortableOperationInProgress *bool

	// The name of the application associated with this environment.
	ApplicationName *string

	// The URL to the CNAME for this environment.
	CNAME *string

	// The creation date for this environment.
	DateCreated *time.Time

	// The last modified date for this environment.
	DateUpdated *time.Time

	// Describes this environment.
	Description *string

	// For load-balanced, autoscaling environments, the URL to the LoadBalancer. For
	// single-instance environments, the IP address of the instance.
	EndpointURL *string

	// The environment's Amazon Resource Name (ARN), which can be used in other API
	// requests that require an ARN.
	EnvironmentArn *string

	// The ID of this environment.
	EnvironmentId *string

	// A list of links to other environments in the same group.
	EnvironmentLinks []types.EnvironmentLink

	// The name of this environment.
	EnvironmentName *string

	// Describes the health status of the environment. AWS Elastic Beanstalk indicates
	// the failure levels for a running environment:
	//
	//   - Red : Indicates the environment is not responsive. Occurs when three or more
	//   consecutive failures occur for an environment.
	//
	//   - Yellow : Indicates that something is wrong. Occurs when two consecutive
	//   failures occur for an environment.
	//
	//   - Green : Indicates the environment is healthy and fully functional.
	//
	//   - Grey : Default health for a new environment. The environment is not fully
	//   launched and health checks have not started or health checks are suspended
	//   during an UpdateEnvironment or RestartEnvironment request.
	//
	// Default: Grey
	Health types.EnvironmentHealth

	// Returns the health status of the application running in your environment. For
	// more information, see [Health Colors and Statuses].
	//
	// [Health Colors and Statuses]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
	HealthStatus types.EnvironmentHealthStatus

	// The Amazon Resource Name (ARN) of the environment's operations role. For more
	// information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide.
	//
	// [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html
	OperationsRole *string

	// The ARN of the platform version.
	PlatformArn *string

	// The description of the AWS resources used by this environment.
	Resources *types.EnvironmentResourcesDescription

	//  The name of the SolutionStack deployed with this environment.
	SolutionStackName *string

	// The current operational status of the environment:
	//
	//   - Launching : Environment is in the process of initial deployment.
	//
	//   - Updating : Environment is in the process of updating its configuration
	//   settings or application version.
	//
	//   - Ready : Environment is available to have an action performed on it, such as
	//   update or terminate.
	//
	//   - Terminating : Environment is in the shut-down process.
	//
	//   - Terminated : Environment is not running.
	Status types.EnvironmentStatus

	// The name of the configuration template used to originally launch this
	// environment.
	TemplateName *string

	// Describes the current tier of this environment.
	Tier *types.EnvironmentTier

	// The application version deployed in this environment.
	VersionLabel *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Describes the properties of an environment.

type UpdateApplicationInput 

type UpdateApplicationInput struct {

	// The name of the application to update. If no such application is found,
	// UpdateApplication returns an InvalidParameterValue error.
	//
	// This member is required.
	ApplicationName *string

	// A new description for the application.
	//
	// Default: If not specified, AWS Elastic Beanstalk does not update the
	// description.
	Description *string
	// contains filtered or unexported fields
}

Request to update an application.

type UpdateApplicationOutput 

type UpdateApplicationOutput struct {

	//  The ApplicationDescription of the application.
	Application *types.ApplicationDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message containing a single description of an application.

type UpdateApplicationResourceLifecycleInput 

type UpdateApplicationResourceLifecycleInput struct {

	// The name of the application.
	//
	// This member is required.
	ApplicationName *string

	// The lifecycle configuration.
	//
	// This member is required.
	ResourceLifecycleConfig *types.ApplicationResourceLifecycleConfig
	// contains filtered or unexported fields
}

type UpdateApplicationResourceLifecycleOutput 

type UpdateApplicationResourceLifecycleOutput struct {

	// The name of the application.
	ApplicationName *string

	// The lifecycle configuration.
	ResourceLifecycleConfig *types.ApplicationResourceLifecycleConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateApplicationVersionInput 

type UpdateApplicationVersionInput struct {

	// The name of the application associated with this version.
	//
	// If no application is found with this name, UpdateApplication returns an
	// InvalidParameterValue error.
	//
	// This member is required.
	ApplicationName *string

	// The name of the version to update.
	//
	// If no application version is found with this label, UpdateApplication returns
	// an InvalidParameterValue error.
	//
	// This member is required.
	VersionLabel *string

	// A new description for this version.
	Description *string
	// contains filtered or unexported fields
}

type UpdateApplicationVersionOutput 

type UpdateApplicationVersionOutput struct {

	//  The ApplicationVersionDescription of the application version.
	ApplicationVersion *types.ApplicationVersionDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result message wrapping a single description of an application version.

type UpdateConfigurationTemplateInput 

type UpdateConfigurationTemplateInput struct {

	// The name of the application associated with the configuration template to
	// update.
	//
	// If no application is found with this name, UpdateConfigurationTemplate returns
	// an InvalidParameterValue error.
	//
	// This member is required.
	ApplicationName *string

	// The name of the configuration template to update.
	//
	// If no configuration template is found with this name,
	// UpdateConfigurationTemplate returns an InvalidParameterValue error.
	//
	// This member is required.
	TemplateName *string

	// A new description for the configuration.
	Description *string

	// A list of configuration option settings to update with the new specified option
	// value.
	OptionSettings []types.ConfigurationOptionSetting

	// A list of configuration options to remove from the configuration set.
	//
	// Constraint: You can remove only UserDefined configuration options.
	OptionsToRemove []types.OptionSpecification
	// contains filtered or unexported fields
}

The result message containing the options for the specified solution stack.

type UpdateConfigurationTemplateOutput 

type UpdateConfigurationTemplateOutput struct {

	// The name of the application associated with this configuration set.
	ApplicationName *string

	// The date (in UTC time) when this configuration set was created.
	DateCreated *time.Time

	// The date (in UTC time) when this configuration set was last modified.
	DateUpdated *time.Time

	//  If this configuration set is associated with an environment, the
	// DeploymentStatus parameter indicates the deployment status of this configuration
	// set:
	//
	//   - null : This configuration is not associated with a running environment.
	//
	//   - pending : This is a draft configuration that is not deployed to the
	//   associated environment but is in the process of deploying.
	//
	//   - deployed : This is the configuration that is currently deployed to the
	//   associated running environment.
	//
	//   - failed : This is a draft configuration that failed to successfully deploy.
	DeploymentStatus types.ConfigurationDeploymentStatus

	// Describes this configuration set.
	Description *string

	//  If not null , the name of the environment for this configuration set.
	EnvironmentName *string

	// A list of the configuration options and their values in this configuration set.
	OptionSettings []types.ConfigurationOptionSetting

	// The ARN of the platform version.
	PlatformArn *string

	// The name of the solution stack this configuration set uses.
	SolutionStackName *string

	//  If not null , the name of the configuration template for this configuration
	// set.
	TemplateName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Describes the settings for a configuration set.

type UpdateEnvironmentInput 

type UpdateEnvironmentInput struct {

	// The name of the application with which the environment is associated.
	ApplicationName *string

	// If this parameter is specified, AWS Elastic Beanstalk updates the description
	// of this environment.
	Description *string

	// The ID of the environment to update.
	//
	// If no environment with this ID exists, AWS Elastic Beanstalk returns an
	// InvalidParameterValue error.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If you
	// do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string

	// The name of the environment to update. If no environment with this name exists,
	// AWS Elastic Beanstalk returns an InvalidParameterValue error.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If you do
	// not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string

	// The name of the group to which the target environment belongs. Specify a group
	// name only if the environment's name is specified in an environment manifest and
	// not with the environment name or environment ID parameters. See [Environment Manifest (env.yaml)]for details.
	//
	// [Environment Manifest (env.yaml)]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
	GroupName *string

	// If specified, AWS Elastic Beanstalk updates the configuration set associated
	// with the running environment and sets the specified configuration options to the
	// requested value.
	OptionSettings []types.ConfigurationOptionSetting

	// A list of custom user-defined configuration options to remove from the
	// configuration set for this environment.
	OptionsToRemove []types.OptionSpecification

	// The ARN of the platform, if used.
	PlatformArn *string

	// This specifies the platform version that the environment will run after the
	// environment is updated.
	SolutionStackName *string

	// If this parameter is specified, AWS Elastic Beanstalk deploys this
	// configuration template to the environment. If no such configuration template is
	// found, AWS Elastic Beanstalk returns an InvalidParameterValue error.
	TemplateName *string

	// This specifies the tier to use to update the environment.
	//
	// Condition: At this time, if you change the tier version, name, or type, AWS
	// Elastic Beanstalk returns InvalidParameterValue error.
	Tier *types.EnvironmentTier

	// If this parameter is specified, AWS Elastic Beanstalk deploys the named
	// application version to the environment. If no such application version is found,
	// returns an InvalidParameterValue error.
	VersionLabel *string
	// contains filtered or unexported fields
}

Request to update an environment.

type UpdateEnvironmentOutput 

type UpdateEnvironmentOutput struct {

	// Indicates if there is an in-progress environment configuration update or
	// application version deployment that you can cancel.
	//
	// true: There is an update in progress.
	//
	// false: There are no updates currently in progress.
	AbortableOperationInProgress *bool

	// The name of the application associated with this environment.
	ApplicationName *string

	// The URL to the CNAME for this environment.
	CNAME *string

	// The creation date for this environment.
	DateCreated *time.Time

	// The last modified date for this environment.
	DateUpdated *time.Time

	// Describes this environment.
	Description *string

	// For load-balanced, autoscaling environments, the URL to the LoadBalancer. For
	// single-instance environments, the IP address of the instance.
	EndpointURL *string

	// The environment's Amazon Resource Name (ARN), which can be used in other API
	// requests that require an ARN.
	EnvironmentArn *string

	// The ID of this environment.
	EnvironmentId *string

	// A list of links to other environments in the same group.
	EnvironmentLinks []types.EnvironmentLink

	// The name of this environment.
	EnvironmentName *string

	// Describes the health status of the environment. AWS Elastic Beanstalk indicates
	// the failure levels for a running environment:
	//
	//   - Red : Indicates the environment is not responsive. Occurs when three or more
	//   consecutive failures occur for an environment.
	//
	//   - Yellow : Indicates that something is wrong. Occurs when two consecutive
	//   failures occur for an environment.
	//
	//   - Green : Indicates the environment is healthy and fully functional.
	//
	//   - Grey : Default health for a new environment. The environment is not fully
	//   launched and health checks have not started or health checks are suspended
	//   during an UpdateEnvironment or RestartEnvironment request.
	//
	// Default: Grey
	Health types.EnvironmentHealth

	// Returns the health status of the application running in your environment. For
	// more information, see [Health Colors and Statuses].
	//
	// [Health Colors and Statuses]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
	HealthStatus types.EnvironmentHealthStatus

	// The Amazon Resource Name (ARN) of the environment's operations role. For more
	// information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide.
	//
	// [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html
	OperationsRole *string

	// The ARN of the platform version.
	PlatformArn *string

	// The description of the AWS resources used by this environment.
	Resources *types.EnvironmentResourcesDescription

	//  The name of the SolutionStack deployed with this environment.
	SolutionStackName *string

	// The current operational status of the environment:
	//
	//   - Launching : Environment is in the process of initial deployment.
	//
	//   - Updating : Environment is in the process of updating its configuration
	//   settings or application version.
	//
	//   - Ready : Environment is available to have an action performed on it, such as
	//   update or terminate.
	//
	//   - Terminating : Environment is in the shut-down process.
	//
	//   - Terminated : Environment is not running.
	Status types.EnvironmentStatus

	// The name of the configuration template used to originally launch this
	// environment.
	TemplateName *string

	// Describes the current tier of this environment.
	Tier *types.EnvironmentTier

	// The application version deployed in this environment.
	VersionLabel *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Describes the properties of an environment.

type UpdateTagsForResourceInput 

type UpdateTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resouce to be updated.
	//
	// Must be the ARN of an Elastic Beanstalk resource.
	//
	// This member is required.
	ResourceArn *string

	// A list of tags to add or update. If a key of an existing tag is added, the
	// tag's value is updated.
	//
	// Specify at least one of these parameters: TagsToAdd , TagsToRemove .
	TagsToAdd []types.Tag

	// A list of tag keys to remove. If a tag key doesn't exist, it is silently
	// ignored.
	//
	// Specify at least one of these parameters: TagsToAdd , TagsToRemove .
	TagsToRemove []string
	// contains filtered or unexported fields
}

type UpdateTagsForResourceOutput 

type UpdateTagsForResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ValidateConfigurationSettingsInput 

type ValidateConfigurationSettingsInput struct {

	// The name of the application that the configuration template or environment
	// belongs to.
	//
	// This member is required.
	ApplicationName *string

	// A list of the options and desired values to evaluate.
	//
	// This member is required.
	OptionSettings []types.ConfigurationOptionSetting

	// The name of the environment to validate the settings against.
	//
	// Condition: You cannot specify both this and a configuration template name.
	EnvironmentName *string

	// The name of the configuration template to validate the settings against.
	//
	// Condition: You cannot specify both this and an environment name.
	TemplateName *string
	// contains filtered or unexported fields
}

A list of validation messages for a specified configuration template.

type ValidateConfigurationSettingsOutput 

type ValidateConfigurationSettingsOutput struct {

	//  A list of ValidationMessage.
	Messages []types.ValidationMessage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Provides a list of validation messages.

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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