codedeploy

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

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

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

Documentation

Overview

Package codedeploy provides the API client, operations, and parameter types for AWS CodeDeploy.

CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.

You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.

CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

CodeDeploy Components

Use the information in this guide to help you work with the following CodeDeploy components:

  • Application: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.

  • Deployment group: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.

  • Deployment configuration: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.

  • Deployment: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.

  • Application revisions: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.

This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.

CodeDeploy Information Resources

CodeDeploy User Guide

CodeDeploy API Reference Guide

CLI Reference for CodeDeploy

CodeDeploy Developer Forum

Index

Constants

View Source 
const ServiceAPIVersion = "2014-10-06"
View Source 
const ServiceID = "CodeDeploy"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName 

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 

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 AddTagsToOnPremisesInstancesInput 

type AddTagsToOnPremisesInstancesInput struct {

	// The names of the on-premises instances to which to add tags.
	//
	// This member is required.
	InstanceNames []string

	// The tag key-value pairs to add to the on-premises instances.
	//
	// Keys and values are both required. Keys cannot be null or empty strings.
	// Value-only tags are not allowed.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

Represents the input of, and adds tags to, an on-premises instance operation.

type AddTagsToOnPremisesInstancesOutput 

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

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

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

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

type BatchGetApplicationRevisionsInput 

type BatchGetApplicationRevisionsInput struct {

	// The name of an CodeDeploy application about which to get revision information.
	//
	// This member is required.
	ApplicationName *string

	// An array of RevisionLocation objects that specify information to get about the
	// application revisions, including type and location. The maximum number of
	// RevisionLocation objects you can specify is 25.
	//
	// This member is required.
	Revisions []types.RevisionLocation
	// contains filtered or unexported fields
}

Represents the input of a BatchGetApplicationRevisions operation.

type BatchGetApplicationRevisionsOutput 

type BatchGetApplicationRevisionsOutput struct {

	// The name of the application that corresponds to the revisions.
	ApplicationName *string

	// Information about errors that might have occurred during the API call.
	ErrorMessage *string

	// Additional information about the revisions, including the type and location.
	Revisions []types.RevisionInfo

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

Represents the output of a BatchGetApplicationRevisions operation.

type BatchGetApplicationsInput 

type BatchGetApplicationsInput struct {

	// A list of application names separated by spaces. The maximum number of
	// application names you can specify is 100.
	//
	// This member is required.
	ApplicationNames []string
	// contains filtered or unexported fields
}

Represents the input of a BatchGetApplications operation.

type BatchGetApplicationsOutput 

type BatchGetApplicationsOutput struct {

	// Information about the applications.
	ApplicationsInfo []types.ApplicationInfo

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

Represents the output of a BatchGetApplications operation.

type BatchGetDeploymentGroupsInput 

type BatchGetDeploymentGroupsInput struct {

	// The name of an CodeDeploy application associated with the applicable user or
	// Amazon Web Services account.
	//
	// This member is required.
	ApplicationName *string

	// The names of the deployment groups.
	//
	// This member is required.
	DeploymentGroupNames []string
	// contains filtered or unexported fields
}

Represents the input of a BatchGetDeploymentGroups operation.

type BatchGetDeploymentGroupsOutput 

type BatchGetDeploymentGroupsOutput struct {

	// Information about the deployment groups.
	DeploymentGroupsInfo []types.DeploymentGroupInfo

	// Information about errors that might have occurred during the API call.
	ErrorMessage *string

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

Represents the output of a BatchGetDeploymentGroups operation.

type BatchGetDeploymentInstancesInput 

type BatchGetDeploymentInstancesInput struct {

	//  The unique ID of a deployment.
	//
	// This member is required.
	DeploymentId *string

	// The unique IDs of instances used in the deployment. The maximum number of
	// instance IDs you can specify is 25.
	//
	// This member is required.
	InstanceIds []string
	// contains filtered or unexported fields
}

Represents the input of a BatchGetDeploymentInstances operation.

type BatchGetDeploymentInstancesOutput 

type BatchGetDeploymentInstancesOutput struct {

	// Information about errors that might have occurred during the API call.
	ErrorMessage *string

	// Information about the instance.
	InstancesSummary []types.InstanceSummary

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

Represents the output of a BatchGetDeploymentInstances operation.

type BatchGetDeploymentTargetsInput 

type BatchGetDeploymentTargetsInput struct {

	//  The unique ID of a deployment.
	//
	// This member is required.
	DeploymentId *string

	//  The unique IDs of the deployment targets. The compute platform of the
	// deployment determines the type of the targets and their formats. The maximum
	// number of deployment target IDs you can specify is 25.
	//
	//   - For deployments that use the EC2/On-premises compute platform, the target
	//   IDs are Amazon EC2 or on-premises instances IDs, and their target type is
	//   instanceTarget .
	//
	//   - For deployments that use the Lambda compute platform, the target IDs are
	//   the names of Lambda functions, and their target type is instanceTarget .
	//
	//   - For deployments that use the Amazon ECS compute platform, the target IDs
	//   are pairs of Amazon ECS clusters and services specified using the format : .
	//   Their target type is ecsTarget .
	//
	//   - For deployments that are deployed with CloudFormation, the target IDs are
	//   CloudFormation stack IDs. Their target type is cloudFormationTarget .
	//
	// This member is required.
	TargetIds []string
	// contains filtered or unexported fields
}

type BatchGetDeploymentTargetsOutput 

type BatchGetDeploymentTargetsOutput struct {

	//  A list of target objects for a deployment. Each target object contains details
	// about the target, such as its status and lifecycle events. The type of the
	// target objects depends on the deployment' compute platform.
	//
	//   - EC2/On-premises: Each target object is an Amazon EC2 or on-premises
	//   instance.
	//
	//   - Lambda: The target object is a specific version of an Lambda function.
	//
	//   - Amazon ECS: The target object is an Amazon ECS service.
	//
	//   - CloudFormation: The target object is an CloudFormation blue/green
	//   deployment.
	DeploymentTargets []types.DeploymentTarget

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

type BatchGetDeploymentsInput 

type BatchGetDeploymentsInput struct {

	//  A list of deployment IDs, separated by spaces. The maximum number of
	// deployment IDs you can specify is 25.
	//
	// This member is required.
	DeploymentIds []string
	// contains filtered or unexported fields
}

Represents the input of a BatchGetDeployments operation.

type BatchGetDeploymentsOutput 

type BatchGetDeploymentsOutput struct {

	//  Information about the deployments.
	DeploymentsInfo []types.DeploymentInfo

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

Represents the output of a BatchGetDeployments operation.

type BatchGetOnPremisesInstancesInput 

type BatchGetOnPremisesInstancesInput struct {

	// The names of the on-premises instances about which to get information. The
	// maximum number of instance names you can specify is 25.
	//
	// This member is required.
	InstanceNames []string
	// contains filtered or unexported fields
}

Represents the input of a BatchGetOnPremisesInstances operation.

type BatchGetOnPremisesInstancesOutput 

type BatchGetOnPremisesInstancesOutput struct {

	// Information about the on-premises instances.
	InstanceInfos []types.InstanceInfo

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

Represents the output of a BatchGetOnPremisesInstances operation.

type Client 

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

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

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) AddTagsToOnPremisesInstances 

func (c *Client) AddTagsToOnPremisesInstances(ctx context.Context, params *AddTagsToOnPremisesInstancesInput, optFns ...func(*Options)) (*AddTagsToOnPremisesInstancesOutput, error)

Adds tags to on-premises instances.

func (*Client) BatchGetApplicationRevisions 

func (c *Client) BatchGetApplicationRevisions(ctx context.Context, params *BatchGetApplicationRevisionsInput, optFns ...func(*Options)) (*BatchGetApplicationRevisionsOutput, error)

Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.

func (*Client) BatchGetApplications 

func (c *Client) BatchGetApplications(ctx context.Context, params *BatchGetApplicationsInput, optFns ...func(*Options)) (*BatchGetApplicationsOutput, error)

Gets information about one or more applications. The maximum number of applications that can be returned is 100.

func (*Client) BatchGetDeploymentGroups 

func (c *Client) BatchGetDeploymentGroups(ctx context.Context, params *BatchGetDeploymentGroupsInput, optFns ...func(*Options)) (*BatchGetDeploymentGroupsOutput, error)

Gets information about one or more deployment groups.

func (*Client) BatchGetDeploymentInstances deprecated 

func (c *Client) BatchGetDeploymentInstances(ctx context.Context, params *BatchGetDeploymentInstancesInput, optFns ...func(*Options)) (*BatchGetDeploymentInstancesOutput, error)
This method works, but is deprecated. Use BatchGetDeploymentTargets instead.

Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25.

Deprecated: This operation is deprecated, use BatchGetDeploymentTargets instead.

func (*Client) BatchGetDeploymentTargets 

func (c *Client) BatchGetDeploymentTargets(ctx context.Context, params *BatchGetDeploymentTargetsInput, optFns ...func(*Options)) (*BatchGetDeploymentTargetsOutput, error)
Returns an array of one or more targets associated with a deployment. This

method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances . The maximum number of targets that can be returned is 25.

The type of targets returned depends on the deployment's compute platform or deployment method:

  • EC2/On-premises: Information about Amazon EC2 instance targets.

  • Lambda: Information about Lambda functions targets.

  • Amazon ECS: Information about Amazon ECS service targets.

  • CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.

func (*Client) BatchGetDeployments 

func (c *Client) BatchGetDeployments(ctx context.Context, params *BatchGetDeploymentsInput, optFns ...func(*Options)) (*BatchGetDeploymentsOutput, error)

Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.

func (*Client) BatchGetOnPremisesInstances 

func (c *Client) BatchGetOnPremisesInstances(ctx context.Context, params *BatchGetOnPremisesInstancesInput, optFns ...func(*Options)) (*BatchGetOnPremisesInstancesOutput, error)

Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.

func (*Client) ContinueDeployment 

func (c *Client) ContinueDeployment(ctx context.Context, params *ContinueDeploymentInput, optFns ...func(*Options)) (*ContinueDeploymentOutput, error)

For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)

func (*Client) CreateApplication 

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

Creates an application.

func (*Client) CreateDeployment 

func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error)

Deploys an application revision through the specified deployment group.

func (*Client) CreateDeploymentConfig 

func (c *Client) CreateDeploymentConfig(ctx context.Context, params *CreateDeploymentConfigInput, optFns ...func(*Options)) (*CreateDeploymentConfigOutput, error)

Creates a deployment configuration.

func (*Client) CreateDeploymentGroup 

func (c *Client) CreateDeploymentGroup(ctx context.Context, params *CreateDeploymentGroupInput, optFns ...func(*Options)) (*CreateDeploymentGroupOutput, error)

Creates a deployment group to which application revisions are deployed.

func (*Client) DeleteApplication 

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

Deletes an application.

func (*Client) DeleteDeploymentConfig 

func (c *Client) DeleteDeploymentConfig(ctx context.Context, params *DeleteDeploymentConfigInput, optFns ...func(*Options)) (*DeleteDeploymentConfigOutput, error)

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.

func (*Client) DeleteDeploymentGroup 

func (c *Client) DeleteDeploymentGroup(ctx context.Context, params *DeleteDeploymentGroupInput, optFns ...func(*Options)) (*DeleteDeploymentGroupOutput, error)

Deletes a deployment group.

func (*Client) DeleteGitHubAccountToken 

func (c *Client) DeleteGitHubAccountToken(ctx context.Context, params *DeleteGitHubAccountTokenInput, optFns ...func(*Options)) (*DeleteGitHubAccountTokenOutput, error)

Deletes a GitHub account connection.

func (*Client) DeleteResourcesByExternalId 

func (c *Client) DeleteResourcesByExternalId(ctx context.Context, params *DeleteResourcesByExternalIdInput, optFns ...func(*Options)) (*DeleteResourcesByExternalIdOutput, error)

Deletes resources linked to an external ID. This action only applies if you have configured blue/green deployments through CloudFormation.

It is not necessary to call this action directly. CloudFormation calls it on your behalf when it needs to delete stack resources. This action is offered publicly in case you need to delete resources to comply with General Data Protection Regulation (GDPR) requirements.

func (*Client) DeregisterOnPremisesInstance 

func (c *Client) DeregisterOnPremisesInstance(ctx context.Context, params *DeregisterOnPremisesInstanceInput, optFns ...func(*Options)) (*DeregisterOnPremisesInstanceOutput, error)

Deregisters an on-premises instance.

func (*Client) GetApplication 

func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)

Gets information about an application.

func (*Client) GetApplicationRevision 

func (c *Client) GetApplicationRevision(ctx context.Context, params *GetApplicationRevisionInput, optFns ...func(*Options)) (*GetApplicationRevisionOutput, error)

Gets information about an application revision.

func (*Client) GetDeployment 

func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error)

Gets information about a deployment.

The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file.

func (*Client) GetDeploymentConfig 

func (c *Client) GetDeploymentConfig(ctx context.Context, params *GetDeploymentConfigInput, optFns ...func(*Options)) (*GetDeploymentConfigOutput, error)

Gets information about a deployment configuration.

func (*Client) GetDeploymentGroup 

func (c *Client) GetDeploymentGroup(ctx context.Context, params *GetDeploymentGroupInput, optFns ...func(*Options)) (*GetDeploymentGroupOutput, error)

Gets information about a deployment group.

func (*Client) GetDeploymentInstance deprecated 

func (c *Client) GetDeploymentInstance(ctx context.Context, params *GetDeploymentInstanceInput, optFns ...func(*Options)) (*GetDeploymentInstanceOutput, error)

Gets information about an instance as part of a deployment.

Deprecated: This operation is deprecated, use GetDeploymentTarget instead.

func (*Client) GetDeploymentTarget 

func (c *Client) GetDeploymentTarget(ctx context.Context, params *GetDeploymentTargetInput, optFns ...func(*Options)) (*GetDeploymentTargetOutput, error)

Returns information about a deployment target.

func (*Client) GetOnPremisesInstance 

func (c *Client) GetOnPremisesInstance(ctx context.Context, params *GetOnPremisesInstanceInput, optFns ...func(*Options)) (*GetOnPremisesInstanceOutput, error)

Gets information about an on-premises instance.

func (*Client) ListApplicationRevisions 

func (c *Client) ListApplicationRevisions(ctx context.Context, params *ListApplicationRevisionsInput, optFns ...func(*Options)) (*ListApplicationRevisionsOutput, error)

Lists information about revisions for an application.

func (*Client) ListApplications 

func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)

Lists the applications registered with the user or Amazon Web Services account.

func (*Client) ListDeploymentConfigs 

func (c *Client) ListDeploymentConfigs(ctx context.Context, params *ListDeploymentConfigsInput, optFns ...func(*Options)) (*ListDeploymentConfigsOutput, error)

Lists the deployment configurations with the user or Amazon Web Services account.

func (*Client) ListDeploymentGroups 

func (c *Client) ListDeploymentGroups(ctx context.Context, params *ListDeploymentGroupsInput, optFns ...func(*Options)) (*ListDeploymentGroupsOutput, error)

Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.

func (*Client) ListDeploymentInstances deprecated 

func (c *Client) ListDeploymentInstances(ctx context.Context, params *ListDeploymentInstancesInput, optFns ...func(*Options)) (*ListDeploymentInstancesOutput, error)
The newer BatchGetDeploymentTargets should be used instead because it works

with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda.

Lists the instance for a deployment associated with the user or Amazon Web Services account.

Deprecated: This operation is deprecated, use ListDeploymentTargets instead.

func (*Client) ListDeploymentTargets 

func (c *Client) ListDeploymentTargets(ctx context.Context, params *ListDeploymentTargetsInput, optFns ...func(*Options)) (*ListDeploymentTargetsOutput, error)

Returns an array of target IDs that are associated a deployment.

func (*Client) ListDeployments 

func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInput, optFns ...func(*Options)) (*ListDeploymentsOutput, error)

Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.

func (*Client) ListGitHubAccountTokenNames 

func (c *Client) ListGitHubAccountTokenNames(ctx context.Context, params *ListGitHubAccountTokenNamesInput, optFns ...func(*Options)) (*ListGitHubAccountTokenNamesOutput, error)

Lists the names of stored connections to GitHub accounts.

func (*Client) ListOnPremisesInstances 

func (c *Client) ListOnPremisesInstances(ctx context.Context, params *ListOnPremisesInstancesInput, optFns ...func(*Options)) (*ListOnPremisesInstancesOutput, error)

Gets a list of names for one or more on-premises instances.

Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Returns a list of tags for the resource identified by a specified Amazon

Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.

func (*Client) Options 

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) PutLifecycleEventHookExecutionStatus 

func (c *Client) PutLifecycleEventHookExecutionStatus(ctx context.Context, params *PutLifecycleEventHookExecutionStatusInput, optFns ...func(*Options)) (*PutLifecycleEventHookExecutionStatusOutput, error)
Sets the result of a Lambda validation function. The function validates

lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are BeforeAllowTraffic and AfterAllowTraffic . For Amazon ECS deployments, the available lifecycle hooks are BeforeInstall , AfterInstall , AfterAllowTestTraffic , BeforeAllowTraffic , and AfterAllowTraffic . Lambda validation functions return Succeeded or Failed . For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.

func (*Client) RegisterApplicationRevision 

func (c *Client) RegisterApplicationRevision(ctx context.Context, params *RegisterApplicationRevisionInput, optFns ...func(*Options)) (*RegisterApplicationRevisionOutput, error)

Registers with CodeDeploy a revision for the specified application.

func (*Client) RegisterOnPremisesInstance 

func (c *Client) RegisterOnPremisesInstance(ctx context.Context, params *RegisterOnPremisesInstanceInput, optFns ...func(*Options)) (*RegisterOnPremisesInstanceOutput, error)

Registers an on-premises instance.

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

func (*Client) RemoveTagsFromOnPremisesInstances 

func (c *Client) RemoveTagsFromOnPremisesInstances(ctx context.Context, params *RemoveTagsFromOnPremisesInstancesInput, optFns ...func(*Options)) (*RemoveTagsFromOnPremisesInstancesOutput, error)

Removes one or more tags from one or more on-premises instances.

func (*Client) SkipWaitTimeForInstanceTermination deprecated 

func (c *Client) SkipWaitTimeForInstanceTermination(ctx context.Context, params *SkipWaitTimeForInstanceTerminationInput, optFns ...func(*Options)) (*SkipWaitTimeForInstanceTerminationOutput, error)

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.

Deprecated: This operation is deprecated, use ContinueDeployment with DeploymentWaitType instead.

func (*Client) StopDeployment 

func (c *Client) StopDeployment(ctx context.Context, params *StopDeploymentInput, optFns ...func(*Options)) (*StopDeploymentOutput, error)

Attempts to stop an ongoing deployment.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Associates the list of tags in the input Tags parameter with the resource

identified by the ResourceArn input parameter.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Disassociates a resource from a list of tags. The resource is identified by

the ResourceArn input parameter. The tags are identified by the list of keys in the TagKeys input parameter.

func (*Client) UpdateApplication 

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

Changes the name of an application.

func (*Client) UpdateDeploymentGroup 

func (c *Client) UpdateDeploymentGroup(ctx context.Context, params *UpdateDeploymentGroupInput, optFns ...func(*Options)) (*UpdateDeploymentGroupOutput, error)

Changes information about a deployment group.

type ContinueDeploymentInput 

type ContinueDeploymentInput struct {

	//  The unique ID of a blue/green deployment for which you want to start rerouting
	// traffic to the replacement environment.
	DeploymentId *string

	//  The status of the deployment's waiting period. READY_WAIT indicates that the
	// deployment is ready to start shifting traffic. TERMINATION_WAIT indicates that
	// the traffic is shifted, but the original target is not terminated.
	DeploymentWaitType types.DeploymentWaitType
	// contains filtered or unexported fields
}

type ContinueDeploymentOutput 

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

type CreateApplicationInput 

type CreateApplicationInput struct {

	// The name of the application. This name must be unique with the applicable user
	// or Amazon Web Services account.
	//
	// This member is required.
	ApplicationName *string

	//  The destination platform type for the deployment ( Lambda , Server , or ECS ).
	ComputePlatform types.ComputePlatform

	//  The metadata that you apply to CodeDeploy applications to help you organize
	// and categorize them. Each tag consists of a key and an optional value, both of
	// which you define.
	Tags []types.Tag
	// contains filtered or unexported fields
}

Represents the input of a CreateApplication operation.

type CreateApplicationOutput 

type CreateApplicationOutput struct {

	// A unique application ID.
	ApplicationId *string

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

Represents the output of a CreateApplication operation.

type CreateDeploymentConfigInput 

type CreateDeploymentConfigInput struct {

	// The name of the deployment configuration to create.
	//
	// This member is required.
	DeploymentConfigName *string

	// The destination platform type for the deployment ( Lambda , Server , or ECS ).
	ComputePlatform types.ComputePlatform

	// The minimum number of healthy instances that should be available at any time
	// during the deployment. There are two parameters expected in the input: type and
	// value.
	//
	// The type parameter takes either of the following values:
	//
	//   - HOST_COUNT: The value parameter represents the minimum number of healthy
	//   instances as an absolute value.
	//
	//   - FLEET_PERCENT: The value parameter represents the minimum number of healthy
	//   instances as a percentage of the total number of instances in the deployment. If
	//   you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts
	//   the percentage to the equivalent number of instances and rounds up fractional
	//   instances.
	//
	// The value parameter takes an integer.
	//
	// For example, to set a minimum of 95% healthy instance, specify a type of
	// FLEET_PERCENT and a value of 95.
	MinimumHealthyHosts *types.MinimumHealthyHosts

	// The configuration that specifies how the deployment traffic is routed.
	TrafficRoutingConfig *types.TrafficRoutingConfig

	// Configure the ZonalConfig object if you want CodeDeploy to deploy your
	// application to one [Availability Zone]at a time, within an Amazon Web Services Region.
	//
	// For more information about the zonal configuration feature, see [zonal configuration] in the
	// CodeDeploy User Guide.
	//
	// [zonal configuration]: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config
	// [Availability Zone]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones
	ZonalConfig *types.ZonalConfig
	// contains filtered or unexported fields
}

Represents the input of a CreateDeploymentConfig operation.

type CreateDeploymentConfigOutput 

type CreateDeploymentConfigOutput struct {

	// A unique deployment configuration ID.
	DeploymentConfigId *string

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

Represents the output of a CreateDeploymentConfig operation.

type CreateDeploymentGroupInput 

type CreateDeploymentGroupInput struct {

	// The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	ApplicationName *string

	// The name of a new deployment group for the specified application.
	//
	// This member is required.
	DeploymentGroupName *string

	// A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the
	// user's behalf when interacting with Amazon Web Services services.
	//
	// This member is required.
	ServiceRoleArn *string

	// Information to add about Amazon CloudWatch alarms when the deployment group is
	// created.
	AlarmConfiguration *types.AlarmConfiguration

	// Configuration information for an automatic rollback that is added when a
	// deployment group is created.
	AutoRollbackConfiguration *types.AutoRollbackConfiguration

	// A list of associated Amazon EC2 Auto Scaling groups.
	AutoScalingGroups []string

	// Information about blue/green deployment options for a deployment group.
	BlueGreenDeploymentConfiguration *types.BlueGreenDeploymentConfiguration

	// If specified, the deployment configuration name can be either one of the
	// predefined configurations provided with CodeDeploy or a custom deployment
	// configuration that you create by calling the create deployment configuration
	// operation.
	//
	// CodeDeployDefault.OneAtATime is the default deployment configuration. It is
	// used if a configuration isn't specified for the deployment or deployment group.
	//
	// For more information about the predefined deployment configurations in
	// CodeDeploy, see [Working with Deployment Configurations in CodeDeploy]in the CodeDeploy User Guide.
	//
	// [Working with Deployment Configurations in CodeDeploy]: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html
	DeploymentConfigName *string

	// Information about the type of deployment, in-place or blue/green, that you want
	// to run and whether to route deployment traffic behind a load balancer.
	DeploymentStyle *types.DeploymentStyle

	// The Amazon EC2 tags on which to filter. The deployment group includes Amazon
	// EC2 instances with any of the specified tags. Cannot be used in the same call as
	// ec2TagSet.
	Ec2TagFilters []types.EC2TagFilter

	// Information about groups of tags applied to Amazon EC2 instances. The
	// deployment group includes only Amazon EC2 instances identified by all the tag
	// groups. Cannot be used in the same call as ec2TagFilters .
	Ec2TagSet *types.EC2TagSet

	//  The target Amazon ECS services in the deployment group. This applies only to
	// deployment groups that use the Amazon ECS compute platform. A target Amazon ECS
	// service is specified as an Amazon ECS cluster and service name pair using the
	// format : .
	EcsServices []types.ECSService

	// Information about the load balancer used in a deployment.
	LoadBalancerInfo *types.LoadBalancerInfo

	// The on-premises instance tags on which to filter. The deployment group includes
	// on-premises instances with any of the specified tags. Cannot be used in the same
	// call as OnPremisesTagSet .
	OnPremisesInstanceTagFilters []types.TagFilter

	// Information about groups of tags applied to on-premises instances. The
	// deployment group includes only on-premises instances identified by all of the
	// tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters .
	OnPremisesTagSet *types.OnPremisesTagSet

	// Indicates what happens when new Amazon EC2 instances are launched
	// mid-deployment and do not receive the deployed application revision.
	//
	// If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or
	// more 'auto-update outdated instances' deployments to apply the deployed
	// application revision to the new Amazon EC2 instances.
	//
	// If this option is set to IGNORE , CodeDeploy does not initiate a deployment to
	// update the new Amazon EC2 instances. This may result in instances having
	// different revisions.
	OutdatedInstancesStrategy types.OutdatedInstancesStrategy

	//  The metadata that you apply to CodeDeploy deployment groups to help you
	// organize and categorize them. Each tag consists of a key and an optional value,
	// both of which you define.
	Tags []types.Tag

	// This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto
	// Scaling. For more information, see [Integrating CodeDeploy with Amazon EC2 Auto Scaling]in the CodeDeploy User Guide.
	//
	// Set terminationHookEnabled to true to have CodeDeploy install a termination
	// hook into your Auto Scaling group when you create a deployment group. When this
	// hook is installed, CodeDeploy will perform termination deployments.
	//
	// For information about termination deployments, see [Enabling termination deployments during Auto Scaling scale-in events] in the CodeDeploy User
	// Guide.
	//
	// For more information about Auto Scaling scale-in events, see the [Scale in] topic in the
	// Amazon EC2 Auto Scaling User Guide.
	//
	// [Enabling termination deployments during Auto Scaling scale-in events]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable
	// [Integrating CodeDeploy with Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html
	// [Scale in]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html#as-lifecycle-scale-in
	TerminationHookEnabled *bool

	// Information about triggers to create when the deployment group is created. For
	// examples, see [Create a Trigger for an CodeDeploy Event]in the CodeDeploy User Guide.
	//
	// [Create a Trigger for an CodeDeploy Event]: https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html
	TriggerConfigurations []types.TriggerConfig
	// contains filtered or unexported fields
}

Represents the input of a CreateDeploymentGroup operation.

type CreateDeploymentGroupOutput 

type CreateDeploymentGroupOutput struct {

	// A unique deployment group ID.
	DeploymentGroupId *string

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

Represents the output of a CreateDeploymentGroup operation.

type CreateDeploymentInput 

type CreateDeploymentInput struct {

	// The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	ApplicationName *string

	// Configuration information for an automatic rollback that is added when a
	// deployment is created.
	AutoRollbackConfiguration *types.AutoRollbackConfiguration

	// The name of a deployment configuration associated with the user or Amazon Web
	// Services account.
	//
	// If not specified, the value configured in the deployment group is used as the
	// default. If the deployment group does not have a deployment configuration
	// associated with it, CodeDeployDefault . OneAtATime is used by default.
	DeploymentConfigName *string

	// The name of the deployment group.
	DeploymentGroupName *string

	// A comment about the deployment.
	Description *string

	// Information about how CodeDeploy handles files that already exist in a
	// deployment target location but weren't part of the previous successful
	// deployment.
	//
	// The fileExistsBehavior parameter takes any of the following values:
	//
	//   - DISALLOW: The deployment fails. This is also the default behavior if no
	//   option is specified.
	//
	//   - OVERWRITE: The version of the file from the application revision currently
	//   being deployed replaces the version already on the instance.
	//
	//   - RETAIN: The version of the file already on the instance is kept and used as
	//   part of the new deployment.
	FileExistsBehavior types.FileExistsBehavior

	//  If true, then if an ApplicationStop , BeforeBlockTraffic , or AfterBlockTraffic
	// deployment lifecycle event to an instance fails, then the deployment continues
	// to the next deployment lifecycle event. For example, if ApplicationStop fails,
	// the deployment continues with DownloadBundle . If BeforeBlockTraffic fails, the
	// deployment continues with BlockTraffic . If AfterBlockTraffic fails, the
	// deployment continues with ApplicationStop .
	//
	// If false or not specified, then if a lifecycle event fails during a deployment
	// to an instance, that deployment fails. If deployment to that instance is part of
	// an overall deployment and the number of healthy hosts is not less than the
	// minimum number of healthy hosts, then a deployment to the next instance is
	// attempted.
	//
	// During a deployment, the CodeDeploy agent runs the scripts specified for
	// ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic in the AppSpec
	// file from the previous successful deployment. (All other scripts are run from
	// the AppSpec file in the current deployment.) If one of these scripts contains an
	// error and does not run successfully, the deployment can fail.
	//
	// If the cause of the failure is a script from the last successful deployment
	// that will never run successfully, create a new deployment and use
	// ignoreApplicationStopFailures to specify that the ApplicationStop ,
	// BeforeBlockTraffic , and AfterBlockTraffic failures should be ignored.
	IgnoreApplicationStopFailures bool

	// Allows you to specify information about alarms associated with a deployment.
	// The alarm configuration that you specify here will override the alarm
	// configuration at the deployment group level. Consider overriding the alarm
	// configuration if you have set up alarms at the deployment group level that are
	// causing deployment failures. In this case, you would call CreateDeployment to
	// create a new deployment that uses a previous application revision that is known
	// to work, and set its alarm configuration to turn off alarm polling. Turning off
	// alarm polling ensures that the new deployment proceeds without being blocked by
	// the alarm that was generated by the previous, failed, deployment.
	//
	// If you specify an overrideAlarmConfiguration , you need the
	// UpdateDeploymentGroup IAM permission when calling CreateDeployment .
	OverrideAlarmConfiguration *types.AlarmConfiguration

	//  The type and location of the revision to deploy.
	Revision *types.RevisionLocation

	//  Information about the instances that belong to the replacement environment in
	// a blue/green deployment.
	TargetInstances *types.TargetInstances

	//  Indicates whether to deploy to all instances or only to instances that are not
	// running the latest application revision.
	UpdateOutdatedInstancesOnly bool
	// contains filtered or unexported fields
}

Represents the input of a CreateDeployment operation.

type CreateDeploymentOutput 

type CreateDeploymentOutput struct {

	//  The unique ID of a deployment.
	DeploymentId *string

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

Represents the output of a CreateDeployment operation.

type DeleteApplicationInput 

type DeleteApplicationInput struct {

	// The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	ApplicationName *string
	// contains filtered or unexported fields
}

Represents the input of a DeleteApplication operation.

type DeleteApplicationOutput 

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

type DeleteDeploymentConfigInput 

type DeleteDeploymentConfigInput struct {

	// The name of a deployment configuration associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	DeploymentConfigName *string
	// contains filtered or unexported fields
}

Represents the input of a DeleteDeploymentConfig operation.

type DeleteDeploymentConfigOutput 

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

type DeleteDeploymentGroupInput 

type DeleteDeploymentGroupInput struct {

	// The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	ApplicationName *string

	// The name of a deployment group for the specified application.
	//
	// This member is required.
	DeploymentGroupName *string
	// contains filtered or unexported fields
}

Represents the input of a DeleteDeploymentGroup operation.

type DeleteDeploymentGroupOutput 

type DeleteDeploymentGroupOutput struct {

	// If the output contains no data, and the corresponding deployment group
	// contained at least one Auto Scaling group, CodeDeploy successfully removed all
	// corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances
	// in the Auto Scaling group. If the output contains data, CodeDeploy could not
	// remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in
	// the Auto Scaling group.
	HooksNotCleanedUp []types.AutoScalingGroup

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

Represents the output of a DeleteDeploymentGroup operation.

type DeleteGitHubAccountTokenInput 

type DeleteGitHubAccountTokenInput struct {

	// The name of the GitHub account connection to delete.
	TokenName *string
	// contains filtered or unexported fields
}

Represents the input of a DeleteGitHubAccount operation.

type DeleteGitHubAccountTokenOutput 

type DeleteGitHubAccountTokenOutput struct {

	// The name of the GitHub account connection that was deleted.
	TokenName *string

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

Represents the output of a DeleteGitHubAccountToken operation.

type DeleteResourcesByExternalIdInput 

type DeleteResourcesByExternalIdInput struct {

	// The unique ID of an external resource (for example, a CloudFormation stack ID)
	// that is linked to one or more CodeDeploy resources.
	ExternalId *string
	// contains filtered or unexported fields
}

type DeleteResourcesByExternalIdOutput 

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

type DeploymentSuccessfulWaiter 

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

DeploymentSuccessfulWaiter defines the waiters for DeploymentSuccessful

func NewDeploymentSuccessfulWaiter 

func NewDeploymentSuccessfulWaiter(client GetDeploymentAPIClient, optFns ...func(*DeploymentSuccessfulWaiterOptions)) *DeploymentSuccessfulWaiter

NewDeploymentSuccessfulWaiter constructs a DeploymentSuccessfulWaiter.

func (*DeploymentSuccessfulWaiter) Wait 

func (w *DeploymentSuccessfulWaiter) Wait(ctx context.Context, params *GetDeploymentInput, maxWaitDur time.Duration, optFns ...func(*DeploymentSuccessfulWaiterOptions)) error

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

func (*DeploymentSuccessfulWaiter) WaitForOutput 

func (w *DeploymentSuccessfulWaiter) WaitForOutput(ctx context.Context, params *GetDeploymentInput, maxWaitDur time.Duration, optFns ...func(*DeploymentSuccessfulWaiterOptions)) (*GetDeploymentOutput, error)

WaitForOutput calls the waiter function for DeploymentSuccessful 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 DeploymentSuccessfulWaiterOptions 

type DeploymentSuccessfulWaiterOptions 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,
	// DeploymentSuccessfulWaiter will use default minimum delay of 15 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, DeploymentSuccessfulWaiter 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, *GetDeploymentInput, *GetDeploymentOutput, error) (bool, error)
}

DeploymentSuccessfulWaiterOptions are waiter options for DeploymentSuccessfulWaiter

type DeregisterOnPremisesInstanceInput 

type DeregisterOnPremisesInstanceInput struct {

	// The name of the on-premises instance to deregister.
	//
	// This member is required.
	InstanceName *string
	// contains filtered or unexported fields
}

Represents the input of a DeregisterOnPremisesInstance operation.

type DeregisterOnPremisesInstanceOutput 

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

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetApplicationInput 

type GetApplicationInput struct {

	// The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	ApplicationName *string
	// contains filtered or unexported fields
}

Represents the input of a GetApplication operation.

type GetApplicationOutput 

type GetApplicationOutput struct {

	// Information about the application.
	Application *types.ApplicationInfo

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

Represents the output of a GetApplication operation.

type GetApplicationRevisionInput 

type GetApplicationRevisionInput struct {

	// The name of the application that corresponds to the revision.
	//
	// This member is required.
	ApplicationName *string

	// Information about the application revision to get, including type and location.
	//
	// This member is required.
	Revision *types.RevisionLocation
	// contains filtered or unexported fields
}

Represents the input of a GetApplicationRevision operation.

type GetApplicationRevisionOutput 

type GetApplicationRevisionOutput struct {

	// The name of the application that corresponds to the revision.
	ApplicationName *string

	// Additional information about the revision, including type and location.
	Revision *types.RevisionLocation

	// General information about the revision.
	RevisionInfo *types.GenericRevisionInfo

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

Represents the output of a GetApplicationRevision operation.

type GetDeploymentAPIClient 

type GetDeploymentAPIClient interface {
	GetDeployment(context.Context, *GetDeploymentInput, ...func(*Options)) (*GetDeploymentOutput, error)
}

GetDeploymentAPIClient is a client that implements the GetDeployment operation.

type GetDeploymentConfigInput 

type GetDeploymentConfigInput struct {

	// The name of a deployment configuration associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	DeploymentConfigName *string
	// contains filtered or unexported fields
}

Represents the input of a GetDeploymentConfig operation.

type GetDeploymentConfigOutput 

type GetDeploymentConfigOutput struct {

	// Information about the deployment configuration.
	DeploymentConfigInfo *types.DeploymentConfigInfo

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

Represents the output of a GetDeploymentConfig operation.

type GetDeploymentGroupInput 

type GetDeploymentGroupInput struct {

	// The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	ApplicationName *string

	// The name of a deployment group for the specified application.
	//
	// This member is required.
	DeploymentGroupName *string
	// contains filtered or unexported fields
}

Represents the input of a GetDeploymentGroup operation.

type GetDeploymentGroupOutput 

type GetDeploymentGroupOutput struct {

	// Information about the deployment group.
	DeploymentGroupInfo *types.DeploymentGroupInfo

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

Represents the output of a GetDeploymentGroup operation.

type GetDeploymentInput 

type GetDeploymentInput struct {

	//  The unique ID of a deployment associated with the user or Amazon Web Services
	// account.
	//
	// This member is required.
	DeploymentId *string
	// contains filtered or unexported fields
}

Represents the input of a GetDeployment operation.

type GetDeploymentInstanceInput 

type GetDeploymentInstanceInput struct {

	//  The unique ID of a deployment.
	//
	// This member is required.
	DeploymentId *string

	//  The unique ID of an instance in the deployment group.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

Represents the input of a GetDeploymentInstance operation.

type GetDeploymentInstanceOutput 

type GetDeploymentInstanceOutput struct {

	//  Information about the instance.
	//
	// Deprecated: InstanceSummary is deprecated, use DeploymentTarget instead.
	InstanceSummary *types.InstanceSummary

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

Represents the output of a GetDeploymentInstance operation.

type GetDeploymentOutput 

type GetDeploymentOutput struct {

	// Information about the deployment.
	DeploymentInfo *types.DeploymentInfo

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

Represents the output of a GetDeployment operation.

type GetDeploymentTargetInput 

type GetDeploymentTargetInput struct {

	//  The unique ID of a deployment.
	//
	// This member is required.
	DeploymentId *string

	//  The unique ID of a deployment target.
	//
	// This member is required.
	TargetId *string
	// contains filtered or unexported fields
}

type GetDeploymentTargetOutput 

type GetDeploymentTargetOutput struct {

	//  A deployment target that contains information about a deployment such as its
	// status, lifecycle events, and when it was last updated. It also contains
	// metadata about the deployment target. The deployment target metadata depends on
	// the deployment target's type ( instanceTarget , lambdaTarget , or ecsTarget ).
	DeploymentTarget *types.DeploymentTarget

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

type GetOnPremisesInstanceInput 

type GetOnPremisesInstanceInput struct {

	//  The name of the on-premises instance about which to get information.
	//
	// This member is required.
	InstanceName *string
	// contains filtered or unexported fields
}

Represents the input of a GetOnPremisesInstance operation.

type GetOnPremisesInstanceOutput 

type GetOnPremisesInstanceOutput struct {

	//  Information about the on-premises instance.
	InstanceInfo *types.InstanceInfo

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

Represents the output of a GetOnPremisesInstance operation.

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 ListApplicationRevisionsAPIClient 

type ListApplicationRevisionsAPIClient interface {
	ListApplicationRevisions(context.Context, *ListApplicationRevisionsInput, ...func(*Options)) (*ListApplicationRevisionsOutput, error)
}

ListApplicationRevisionsAPIClient is a client that implements the ListApplicationRevisions operation.

type ListApplicationRevisionsInput 

type ListApplicationRevisionsInput struct {

	//  The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	ApplicationName *string

	//  Whether to list revisions based on whether the revision is the target revision
	// of a deployment group:
	//
	//   - include : List revisions that are target revisions of a deployment group.
	//
	//   - exclude : Do not list revisions that are target revisions of a deployment
	//   group.
	//
	//   - ignore : List all revisions.
	Deployed types.ListStateFilterAction

	// An identifier returned from the previous ListApplicationRevisions call. It can
	// be used to return the next set of applications in the list.
	NextToken *string

	//  An Amazon S3 bucket name to limit the search for revisions.
	//
	// If set to null, all of the user's buckets are searched.
	S3Bucket *string

	//  A key prefix for the set of Amazon S3 objects to limit the search for
	// revisions.
	S3KeyPrefix *string

	// The column name to use to sort the list results:
	//
	//   - registerTime : Sort by the time the revisions were registered with
	//   CodeDeploy.
	//
	//   - firstUsedTime : Sort by the time the revisions were first used in a
	//   deployment.
	//
	//   - lastUsedTime : Sort by the time the revisions were last used in a deployment.
	//
	// If not specified or set to null, the results are returned in an arbitrary
	// order.
	SortBy types.ApplicationRevisionSortBy

	//  The order in which to sort the list results:
	//
	//   - ascending : ascending order.
	//
	//   - descending : descending order.
	//
	// If not specified, the results are sorted in ascending order.
	//
	// If set to null, the results are sorted in an arbitrary order.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

Represents the input of a ListApplicationRevisions operation.

type ListApplicationRevisionsOutput 

type ListApplicationRevisionsOutput struct {

	// If a large amount of information is returned, an identifier is also returned.
	// It can be used in a subsequent list application revisions call to return the
	// next set of application revisions in the list.
	NextToken *string

	// A list of locations that contain the matching revisions.
	Revisions []types.RevisionLocation

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

Represents the output of a ListApplicationRevisions operation.

type ListApplicationRevisionsPaginator 

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

ListApplicationRevisionsPaginator is a paginator for ListApplicationRevisions

func NewListApplicationRevisionsPaginator 

func NewListApplicationRevisionsPaginator(client ListApplicationRevisionsAPIClient, params *ListApplicationRevisionsInput, optFns ...func(*ListApplicationRevisionsPaginatorOptions)) *ListApplicationRevisionsPaginator

NewListApplicationRevisionsPaginator returns a new ListApplicationRevisionsPaginator

func (*ListApplicationRevisionsPaginator) HasMorePages 

func (p *ListApplicationRevisionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationRevisionsPaginator) NextPage 

func (p *ListApplicationRevisionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationRevisionsOutput, error)

NextPage retrieves the next ListApplicationRevisions page.

type ListApplicationRevisionsPaginatorOptions 

type ListApplicationRevisionsPaginatorOptions struct {
	// 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
}

ListApplicationRevisionsPaginatorOptions is the paginator options for ListApplicationRevisions

type ListApplicationsAPIClient 

type ListApplicationsAPIClient interface {
	ListApplications(context.Context, *ListApplicationsInput, ...func(*Options)) (*ListApplicationsOutput, error)
}

ListApplicationsAPIClient is a client that implements the ListApplications operation.

type ListApplicationsInput 

type ListApplicationsInput struct {

	// An identifier returned from the previous list applications call. It can be used
	// to return the next set of applications in the list.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListApplications operation.

type ListApplicationsOutput 

type ListApplicationsOutput struct {

	// A list of application names.
	Applications []string

	// If a large amount of information is returned, an identifier is also returned.
	// It can be used in a subsequent list applications call to return the next set of
	// applications in the list.
	NextToken *string

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

Represents the output of a ListApplications operation.

type ListApplicationsPaginator 

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

ListApplicationsPaginator is a paginator for ListApplications

func NewListApplicationsPaginator 

func NewListApplicationsPaginator(client ListApplicationsAPIClient, params *ListApplicationsInput, optFns ...func(*ListApplicationsPaginatorOptions)) *ListApplicationsPaginator

NewListApplicationsPaginator returns a new ListApplicationsPaginator

func (*ListApplicationsPaginator) HasMorePages 

func (p *ListApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationsPaginator) NextPage 

func (p *ListApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationsOutput, error)

NextPage retrieves the next ListApplications page.

type ListApplicationsPaginatorOptions 

type ListApplicationsPaginatorOptions struct {
	// 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
}

ListApplicationsPaginatorOptions is the paginator options for ListApplications

type ListDeploymentConfigsAPIClient 

type ListDeploymentConfigsAPIClient interface {
	ListDeploymentConfigs(context.Context, *ListDeploymentConfigsInput, ...func(*Options)) (*ListDeploymentConfigsOutput, error)
}

ListDeploymentConfigsAPIClient is a client that implements the ListDeploymentConfigs operation.

type ListDeploymentConfigsInput 

type ListDeploymentConfigsInput struct {

	// An identifier returned from the previous ListDeploymentConfigs call. It can be
	// used to return the next set of deployment configurations in the list.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListDeploymentConfigs operation.

type ListDeploymentConfigsOutput 

type ListDeploymentConfigsOutput struct {

	// A list of deployment configurations, including built-in configurations such as
	// CodeDeployDefault.OneAtATime .
	DeploymentConfigsList []string

	// If a large amount of information is returned, an identifier is also returned.
	// It can be used in a subsequent list deployment configurations call to return the
	// next set of deployment configurations in the list.
	NextToken *string

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

Represents the output of a ListDeploymentConfigs operation.

type ListDeploymentConfigsPaginator 

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

ListDeploymentConfigsPaginator is a paginator for ListDeploymentConfigs

func NewListDeploymentConfigsPaginator 

func NewListDeploymentConfigsPaginator(client ListDeploymentConfigsAPIClient, params *ListDeploymentConfigsInput, optFns ...func(*ListDeploymentConfigsPaginatorOptions)) *ListDeploymentConfigsPaginator

NewListDeploymentConfigsPaginator returns a new ListDeploymentConfigsPaginator

func (*ListDeploymentConfigsPaginator) HasMorePages 

func (p *ListDeploymentConfigsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeploymentConfigsPaginator) NextPage 

func (p *ListDeploymentConfigsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeploymentConfigsOutput, error)

NextPage retrieves the next ListDeploymentConfigs page.

type ListDeploymentConfigsPaginatorOptions 

type ListDeploymentConfigsPaginatorOptions struct {
	// 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
}

ListDeploymentConfigsPaginatorOptions is the paginator options for ListDeploymentConfigs

type ListDeploymentGroupsAPIClient 

type ListDeploymentGroupsAPIClient interface {
	ListDeploymentGroups(context.Context, *ListDeploymentGroupsInput, ...func(*Options)) (*ListDeploymentGroupsOutput, error)
}

ListDeploymentGroupsAPIClient is a client that implements the ListDeploymentGroups operation.

type ListDeploymentGroupsInput 

type ListDeploymentGroupsInput struct {

	// The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	ApplicationName *string

	// An identifier returned from the previous list deployment groups call. It can be
	// used to return the next set of deployment groups in the list.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListDeploymentGroups operation.

type ListDeploymentGroupsOutput 

type ListDeploymentGroupsOutput struct {

	// The application name.
	ApplicationName *string

	// A list of deployment group names.
	DeploymentGroups []string

	// If a large amount of information is returned, an identifier is also returned.
	// It can be used in a subsequent list deployment groups call to return the next
	// set of deployment groups in the list.
	NextToken *string

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

Represents the output of a ListDeploymentGroups operation.

type ListDeploymentGroupsPaginator 

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

ListDeploymentGroupsPaginator is a paginator for ListDeploymentGroups

func NewListDeploymentGroupsPaginator 

func NewListDeploymentGroupsPaginator(client ListDeploymentGroupsAPIClient, params *ListDeploymentGroupsInput, optFns ...func(*ListDeploymentGroupsPaginatorOptions)) *ListDeploymentGroupsPaginator

NewListDeploymentGroupsPaginator returns a new ListDeploymentGroupsPaginator

func (*ListDeploymentGroupsPaginator) HasMorePages 

func (p *ListDeploymentGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeploymentGroupsPaginator) NextPage 

func (p *ListDeploymentGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeploymentGroupsOutput, error)

NextPage retrieves the next ListDeploymentGroups page.

type ListDeploymentGroupsPaginatorOptions 

type ListDeploymentGroupsPaginatorOptions struct {
	// 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
}

ListDeploymentGroupsPaginatorOptions is the paginator options for ListDeploymentGroups

type ListDeploymentInstancesAPIClient 

type ListDeploymentInstancesAPIClient interface {
	ListDeploymentInstances(context.Context, *ListDeploymentInstancesInput, ...func(*Options)) (*ListDeploymentInstancesOutput, error)
}

ListDeploymentInstancesAPIClient is a client that implements the ListDeploymentInstances operation.

type ListDeploymentInstancesInput 

type ListDeploymentInstancesInput struct {

	//  The unique ID of a deployment.
	//
	// This member is required.
	DeploymentId *string

	// A subset of instances to list by status:
	//
	//   - Pending : Include those instances with pending deployments.
	//
	//   - InProgress : Include those instances where deployments are still in progress.
	//
	//   - Succeeded : Include those instances with successful deployments.
	//
	//   - Failed : Include those instances with failed deployments.
	//
	//   - Skipped : Include those instances with skipped deployments.
	//
	//   - Unknown : Include those instances with deployments in an unknown state.
	InstanceStatusFilter []types.InstanceStatus

	// The set of instances in a blue/green deployment, either those in the original
	// environment ("BLUE") or those in the replacement environment ("GREEN"), for
	// which you want to view instance information.
	InstanceTypeFilter []types.InstanceType

	// An identifier returned from the previous list deployment instances call. It can
	// be used to return the next set of deployment instances in the list.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListDeploymentInstances operation.

type ListDeploymentInstancesOutput 

type ListDeploymentInstancesOutput struct {

	// A list of instance IDs.
	InstancesList []string

	// If a large amount of information is returned, an identifier is also returned.
	// It can be used in a subsequent list deployment instances call to return the next
	// set of deployment instances in the list.
	NextToken *string

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

Represents the output of a ListDeploymentInstances operation.

type ListDeploymentInstancesPaginator 

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

ListDeploymentInstancesPaginator is a paginator for ListDeploymentInstances

func NewListDeploymentInstancesPaginator 

func NewListDeploymentInstancesPaginator(client ListDeploymentInstancesAPIClient, params *ListDeploymentInstancesInput, optFns ...func(*ListDeploymentInstancesPaginatorOptions)) *ListDeploymentInstancesPaginator

NewListDeploymentInstancesPaginator returns a new ListDeploymentInstancesPaginator

func (*ListDeploymentInstancesPaginator) HasMorePages 

func (p *ListDeploymentInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeploymentInstancesPaginator) NextPage 

func (p *ListDeploymentInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeploymentInstancesOutput, error)

NextPage retrieves the next ListDeploymentInstances page.

type ListDeploymentInstancesPaginatorOptions 

type ListDeploymentInstancesPaginatorOptions struct {
	// 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
}

ListDeploymentInstancesPaginatorOptions is the paginator options for ListDeploymentInstances

type ListDeploymentTargetsInput 

type ListDeploymentTargetsInput struct {

	//  The unique ID of a deployment.
	//
	// This member is required.
	DeploymentId *string

	//  A token identifier returned from the previous ListDeploymentTargets call. It
	// can be used to return the next set of deployment targets in the list.
	NextToken *string

	//  A key used to filter the returned targets. The two valid values are:
	//
	//   - TargetStatus - A TargetStatus filter string can be Failed , InProgress ,
	//   Pending , Ready , Skipped , Succeeded , or Unknown .
	//
	//   - ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or
	//   Green .
	TargetFilters map[string][]string
	// contains filtered or unexported fields
}

type ListDeploymentTargetsOutput 

type ListDeploymentTargetsOutput struct {

	//  If a large amount of information is returned, a token identifier is also
	// returned. It can be used in a subsequent ListDeploymentTargets call to return
	// the next set of deployment targets in the list.
	NextToken *string

	//  The unique IDs of deployment targets.
	TargetIds []string

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

type ListDeploymentsAPIClient 

type ListDeploymentsAPIClient interface {
	ListDeployments(context.Context, *ListDeploymentsInput, ...func(*Options)) (*ListDeploymentsOutput, error)
}

ListDeploymentsAPIClient is a client that implements the ListDeployments operation.

type ListDeploymentsInput 

type ListDeploymentsInput struct {

	// The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// If applicationName is specified, then deploymentGroupName must be specified. If
	// it is not specified, then deploymentGroupName must not be specified.
	ApplicationName *string

	// A time range (start and end) for returning a subset of the list of deployments.
	CreateTimeRange *types.TimeRange

	// The name of a deployment group for the specified application.
	//
	// If deploymentGroupName is specified, then applicationName must be specified. If
	// it is not specified, then applicationName must not be specified.
	DeploymentGroupName *string

	// The unique ID of an external resource for returning deployments linked to the
	// external resource.
	ExternalId *string

	// A subset of deployments to list by status:
	//
	//   - Created : Include created deployments in the resulting list.
	//
	//   - Queued : Include queued deployments in the resulting list.
	//
	//   - In Progress : Include in-progress deployments in the resulting list.
	//
	//   - Succeeded : Include successful deployments in the resulting list.
	//
	//   - Failed : Include failed deployments in the resulting list.
	//
	//   - Stopped : Include stopped deployments in the resulting list.
	IncludeOnlyStatuses []types.DeploymentStatus

	// An identifier returned from the previous list deployments call. It can be used
	// to return the next set of deployments in the list.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListDeployments operation.

type ListDeploymentsOutput 

type ListDeploymentsOutput struct {

	// A list of deployment IDs.
	Deployments []string

	// If a large amount of information is returned, an identifier is also returned.
	// It can be used in a subsequent list deployments call to return the next set of
	// deployments in the list.
	NextToken *string

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

Represents the output of a ListDeployments operation.

type ListDeploymentsPaginator 

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

ListDeploymentsPaginator is a paginator for ListDeployments

func NewListDeploymentsPaginator 

func NewListDeploymentsPaginator(client ListDeploymentsAPIClient, params *ListDeploymentsInput, optFns ...func(*ListDeploymentsPaginatorOptions)) *ListDeploymentsPaginator

NewListDeploymentsPaginator returns a new ListDeploymentsPaginator

func (*ListDeploymentsPaginator) HasMorePages 

func (p *ListDeploymentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeploymentsPaginator) NextPage 

func (p *ListDeploymentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeploymentsOutput, error)

NextPage retrieves the next ListDeployments page.

type ListDeploymentsPaginatorOptions 

type ListDeploymentsPaginatorOptions struct {
	// 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
}

ListDeploymentsPaginatorOptions is the paginator options for ListDeployments

type ListGitHubAccountTokenNamesInput 

type ListGitHubAccountTokenNamesInput struct {

	// An identifier returned from the previous ListGitHubAccountTokenNames call. It
	// can be used to return the next set of names in the list.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListGitHubAccountTokenNames operation.

type ListGitHubAccountTokenNamesOutput 

type ListGitHubAccountTokenNamesOutput struct {

	// If a large amount of information is returned, an identifier is also returned.
	// It can be used in a subsequent ListGitHubAccountTokenNames call to return the
	// next set of names in the list.
	NextToken *string

	// A list of names of connections to GitHub accounts.
	TokenNameList []string

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

Represents the output of a ListGitHubAccountTokenNames operation.

type ListOnPremisesInstancesInput 

type ListOnPremisesInstancesInput struct {

	// An identifier returned from the previous list on-premises instances call. It
	// can be used to return the next set of on-premises instances in the list.
	NextToken *string

	// The registration status of the on-premises instances:
	//
	//   - Deregistered : Include deregistered on-premises instances in the resulting
	//   list.
	//
	//   - Registered : Include registered on-premises instances in the resulting list.
	RegistrationStatus types.RegistrationStatus

	// The on-premises instance tags that are used to restrict the on-premises
	// instance names returned.
	TagFilters []types.TagFilter
	// contains filtered or unexported fields
}

Represents the input of a ListOnPremisesInstances operation.

type ListOnPremisesInstancesOutput 

type ListOnPremisesInstancesOutput struct {

	// The list of matching on-premises instance names.
	InstanceNames []string

	// If a large amount of information is returned, an identifier is also returned.
	// It can be used in a subsequent list on-premises instances call to return the
	// next set of on-premises instances in the list.
	NextToken *string

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

Represents the output of the list on-premises instances operation.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	//  The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags
	// associated with the resource that is identified by the ResourceArn .
	//
	// This member is required.
	ResourceArn *string

	// An identifier returned from the previous ListTagsForResource call. It can be
	// used to return the next set of applications in the list.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// If a large amount of information is returned, an identifier is also returned.
	// It can be used in a subsequent list application revisions call to return the
	// next set of application revisions in the list.
	NextToken *string

	//  A list of tags returned by ListTagsForResource . The tags are associated with
	// the resource identified by the input ResourceArn parameter.
	Tags []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 region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver 

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

type PutLifecycleEventHookExecutionStatusInput 

type PutLifecycleEventHookExecutionStatusInput struct {

	//  The unique ID of a deployment. Pass this ID to a Lambda function that
	// validates a deployment lifecycle event.
	DeploymentId *string

	//  The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook
	// is specified in the hooks section of the AppSpec file.
	LifecycleEventHookExecutionId *string

	// The result of a Lambda function that validates a deployment lifecycle event.
	// The values listed in Valid Values are valid for lifecycle statuses in general;
	// however, only Succeeded and Failed can be passed successfully in your API call.
	Status types.LifecycleEventStatus
	// contains filtered or unexported fields
}

type PutLifecycleEventHookExecutionStatusOutput 

type PutLifecycleEventHookExecutionStatusOutput struct {

	// The execution ID of the lifecycle event hook. A hook is specified in the hooks
	// section of the deployment's AppSpec file.
	LifecycleEventHookExecutionId *string

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

type RegisterApplicationRevisionInput 

type RegisterApplicationRevisionInput struct {

	// The name of an CodeDeploy application associated with the user or Amazon Web
	// Services account.
	//
	// This member is required.
	ApplicationName *string

	// Information about the application revision to register, including type and
	// location.
	//
	// This member is required.
	Revision *types.RevisionLocation

	// A comment about the revision.
	Description *string
	// contains filtered or unexported fields
}

Represents the input of a RegisterApplicationRevision operation.

type RegisterApplicationRevisionOutput 

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

type RegisterOnPremisesInstanceInput 

type RegisterOnPremisesInstanceInput struct {

	// The name of the on-premises instance to register.
	//
	// This member is required.
	InstanceName *string

	// The ARN of the IAM session to associate with the on-premises instance.
	IamSessionArn *string

	// The ARN of the user to associate with the on-premises instance.
	IamUserArn *string
	// contains filtered or unexported fields
}

Represents the input of the register on-premises instance operation.

type RegisterOnPremisesInstanceOutput 

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

type RemoveTagsFromOnPremisesInstancesInput 

type RemoveTagsFromOnPremisesInstancesInput struct {

	// The names of the on-premises instances from which to remove tags.
	//
	// This member is required.
	InstanceNames []string

	// The tag key-value pairs to remove from the on-premises instances.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

Represents the input of a RemoveTagsFromOnPremisesInstances operation.

type RemoveTagsFromOnPremisesInstancesOutput 

type RemoveTagsFromOnPremisesInstancesOutput 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 SkipWaitTimeForInstanceTerminationInput 

type SkipWaitTimeForInstanceTerminationInput struct {

	//  The unique ID of a blue/green deployment for which you want to skip the
	// instance termination wait time.
	DeploymentId *string
	// contains filtered or unexported fields
}

type SkipWaitTimeForInstanceTerminationOutput 

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

type StopDeploymentInput 

type StopDeploymentInput struct {

	//  The unique ID of a deployment.
	//
	// This member is required.
	DeploymentId *string

	//  Indicates, when a deployment is stopped, whether instances that have been
	// updated should be rolled back to the previous version of the application
	// revision.
	AutoRollbackEnabled *bool
	// contains filtered or unexported fields
}

Represents the input of a StopDeployment operation.

type StopDeploymentOutput 

type StopDeploymentOutput struct {

	// The status of the stop deployment operation:
	//
	//   - Pending: The stop operation is pending.
	//
	//   - Succeeded: The stop operation was successful.
	Status types.StopStatus

	// An accompanying status message.
	StatusMessage *string

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

Represents the output of a StopDeployment operation.

type TagResourceInput 

type TagResourceInput struct {

	//  The ARN of a resource, such as a CodeDeploy application or deployment group.
	//
	// This member is required.
	ResourceArn *string

	//  A list of tags that TagResource associates with a resource. The resource is
	// identified by the ResourceArn input parameter.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

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

type UntagResourceInput 

type UntagResourceInput struct {

	//  The Amazon Resource Name (ARN) that specifies from which resource to
	// disassociate the tags with the keys in the TagKeys input parameter.
	//
	// This member is required.
	ResourceArn *string

	//  A list of keys of Tag objects. The Tag objects identified by the keys are
	// disassociated from the resource specified by the ResourceArn input parameter.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

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

type UpdateApplicationInput 

type UpdateApplicationInput struct {

	// The current name of the application you want to change.
	ApplicationName *string

	// The new name to give the application.
	NewApplicationName *string
	// contains filtered or unexported fields
}

Represents the input of an UpdateApplication operation.

type UpdateApplicationOutput 

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

type UpdateDeploymentGroupInput 

type UpdateDeploymentGroupInput struct {

	// The application name that corresponds to the deployment group to update.
	//
	// This member is required.
	ApplicationName *string

	// The current name of the deployment group.
	//
	// This member is required.
	CurrentDeploymentGroupName *string

	// Information to add or change about Amazon CloudWatch alarms when the deployment
	// group is updated.
	AlarmConfiguration *types.AlarmConfiguration

	// Information for an automatic rollback configuration that is added or changed
	// when a deployment group is updated.
	AutoRollbackConfiguration *types.AutoRollbackConfiguration

	// The replacement list of Auto Scaling groups to be included in the deployment
	// group, if you want to change them.
	//
	//   - To keep the Auto Scaling groups, enter their names or do not specify this
	//   parameter.
	//
	//   - To remove Auto Scaling groups, specify a non-null empty list of Auto
	//   Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle
	//   hooks. For examples, see [Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout"]in the CodeDeploy User Guide.
	//
	// [Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout"]: https://docs.aws.amazon.com/codedeploy/latest/userguide/troubleshooting-auto-scaling.html#troubleshooting-auto-scaling-heartbeat
	AutoScalingGroups []string

	// Information about blue/green deployment options for a deployment group.
	BlueGreenDeploymentConfiguration *types.BlueGreenDeploymentConfiguration

	// The replacement deployment configuration name to use, if you want to change it.
	DeploymentConfigName *string

	// Information about the type of deployment, either in-place or blue/green, you
	// want to run and whether to route deployment traffic behind a load balancer.
	DeploymentStyle *types.DeploymentStyle

	// The replacement set of Amazon EC2 tags on which to filter, if you want to
	// change them. To keep the existing tags, enter their names. To remove tags, do
	// not enter any tag names.
	Ec2TagFilters []types.EC2TagFilter

	// Information about groups of tags applied to on-premises instances. The
	// deployment group includes only Amazon EC2 instances identified by all the tag
	// groups.
	Ec2TagSet *types.EC2TagSet

	//  The target Amazon ECS services in the deployment group. This applies only to
	// deployment groups that use the Amazon ECS compute platform. A target Amazon ECS
	// service is specified as an Amazon ECS cluster and service name pair using the
	// format : .
	EcsServices []types.ECSService

	// Information about the load balancer used in a deployment.
	LoadBalancerInfo *types.LoadBalancerInfo

	// The new name of the deployment group, if you want to change it.
	NewDeploymentGroupName *string

	// The replacement set of on-premises instance tags on which to filter, if you
	// want to change them. To keep the existing tags, enter their names. To remove
	// tags, do not enter any tag names.
	OnPremisesInstanceTagFilters []types.TagFilter

	// Information about an on-premises instance tag set. The deployment group
	// includes only on-premises instances identified by all the tag groups.
	OnPremisesTagSet *types.OnPremisesTagSet

	// Indicates what happens when new Amazon EC2 instances are launched
	// mid-deployment and do not receive the deployed application revision.
	//
	// If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or
	// more 'auto-update outdated instances' deployments to apply the deployed
	// application revision to the new Amazon EC2 instances.
	//
	// If this option is set to IGNORE , CodeDeploy does not initiate a deployment to
	// update the new Amazon EC2 instances. This may result in instances having
	// different revisions.
	OutdatedInstancesStrategy types.OutdatedInstancesStrategy

	// A replacement ARN for the service role, if you want to change it.
	ServiceRoleArn *string

	// This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto
	// Scaling. For more information, see [Integrating CodeDeploy with Amazon EC2 Auto Scaling]in the CodeDeploy User Guide.
	//
	// Set terminationHookEnabled to true to have CodeDeploy install a termination
	// hook into your Auto Scaling group when you update a deployment group. When this
	// hook is installed, CodeDeploy will perform termination deployments.
	//
	// For information about termination deployments, see [Enabling termination deployments during Auto Scaling scale-in events] in the CodeDeploy User
	// Guide.
	//
	// For more information about Auto Scaling scale-in events, see the [Scale in] topic in the
	// Amazon EC2 Auto Scaling User Guide.
	//
	// [Enabling termination deployments during Auto Scaling scale-in events]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable
	// [Integrating CodeDeploy with Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html
	// [Scale in]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html#as-lifecycle-scale-in
	TerminationHookEnabled *bool

	// Information about triggers to change when the deployment group is updated. For
	// examples, see [Edit a Trigger in a CodeDeploy Deployment Group]in the CodeDeploy User Guide.
	//
	// [Edit a Trigger in a CodeDeploy Deployment Group]: https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html
	TriggerConfigurations []types.TriggerConfig
	// contains filtered or unexported fields
}

Represents the input of an UpdateDeploymentGroup operation.

type UpdateDeploymentGroupOutput 

type UpdateDeploymentGroupOutput struct {

	// If the output contains no data, and the corresponding deployment group
	// contained at least one Auto Scaling group, CodeDeploy successfully removed all
	// corresponding Auto Scaling lifecycle event hooks from the Amazon Web Services
	// account. If the output contains data, CodeDeploy could not remove some Auto
	// Scaling lifecycle event hooks from the Amazon Web Services account.
	HooksNotCleanedUp []types.AutoScalingGroup

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

Represents the output of an UpdateDeploymentGroup operation.

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.