github.com/aavshr/aws-sdk-go@v1.41.3/service/codedeploy/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package codedeploy provides the client and types for making API
     4  // requests to AWS CodeDeploy.
     5  //
     6  // AWS CodeDeploy is a deployment service that automates application deployments
     7  // to Amazon EC2 instances, on-premises instances running in your own facility,
     8  // serverless AWS Lambda functions, or applications in an Amazon ECS service.
     9  //
    10  // You can deploy a nearly unlimited variety of application content, such as
    11  // an updated Lambda function, updated applications in an Amazon ECS service,
    12  // code, web and configuration files, executables, packages, scripts, multimedia
    13  // files, and so on. AWS CodeDeploy can deploy application content stored in
    14  // Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do
    15  // not need to make changes to your existing code before you can use AWS CodeDeploy.
    16  //
    17  // AWS CodeDeploy makes it easier for you to rapidly release new features, helps
    18  // you avoid downtime during application deployment, and handles the complexity
    19  // of updating your applications, without many of the risks associated with
    20  // error-prone manual deployments.
    21  //
    22  // AWS CodeDeploy Components
    23  //
    24  // Use the information in this guide to help you work with the following AWS
    25  // CodeDeploy components:
    26  //
    27  //    * Application: A name that uniquely identifies the application you want
    28  //    to deploy. AWS CodeDeploy uses this name, which functions as a container,
    29  //    to ensure the correct combination of revision, deployment configuration,
    30  //    and deployment group are referenced during a deployment.
    31  //
    32  //    * Deployment group: A set of individual instances, CodeDeploy Lambda deployment
    33  //    configuration settings, or an Amazon ECS service and network details.
    34  //    A Lambda deployment group specifies how to route traffic to a new version
    35  //    of a Lambda function. An Amazon ECS deployment group specifies the service
    36  //    created in Amazon ECS to deploy, a load balancer, and a listener to reroute
    37  //    production traffic to an updated containerized application. An EC2/On-premises
    38  //    deployment group contains individually tagged instances, Amazon EC2 instances
    39  //    in Amazon EC2 Auto Scaling groups, or both. All deployment groups can
    40  //    specify optional trigger, alarm, and rollback settings.
    41  //
    42  //    * Deployment configuration: A set of deployment rules and deployment success
    43  //    and failure conditions used by AWS CodeDeploy during a deployment.
    44  //
    45  //    * Deployment: The process and the components used when updating a Lambda
    46  //    function, a containerized application in an Amazon ECS service, or of
    47  //    installing content on one or more instances.
    48  //
    49  //    * Application revisions: For an AWS Lambda deployment, this is an AppSpec
    50  //    file that specifies the Lambda function to be updated and one or more
    51  //    functions to validate deployment lifecycle events. For an Amazon ECS deployment,
    52  //    this is an AppSpec file that specifies the Amazon ECS task definition,
    53  //    container, and port where production traffic is rerouted. For an EC2/On-premises
    54  //    deployment, this is an archive file that contains source content—source
    55  //    code, webpages, executable files, and deployment scripts—along with
    56  //    an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories.
    57  //    For Amazon S3, a revision is uniquely identified by its Amazon S3 object
    58  //    key and its ETag, version, or both. For GitHub, a revision is uniquely
    59  //    identified by its commit ID.
    60  //
    61  // This guide also contains information to help you get details about the instances
    62  // in your deployments, to make on-premises instances available for AWS CodeDeploy
    63  // deployments, to get details about a Lambda function deployment, and to get
    64  // details about Amazon ECS service deployments.
    65  //
    66  // AWS CodeDeploy Information Resources
    67  //
    68  //    * AWS CodeDeploy User Guide (https://docs.aws.amazon.com/codedeploy/latest/userguide)
    69  //
    70  //    * AWS CodeDeploy API Reference Guide (https://docs.aws.amazon.com/codedeploy/latest/APIReference/)
    71  //
    72  //    * AWS CLI Reference for AWS CodeDeploy (https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html)
    73  //
    74  //    * AWS CodeDeploy Developer Forum (https://forums.aws.amazon.com/forum.jspa?forumID=179)
    75  //
    76  // See https://docs.aws.amazon.com/goto/WebAPI/codedeploy-2014-10-06 for more information on this service.
    77  //
    78  // See codedeploy package documentation for more information.
    79  // https://docs.aws.amazon.com/sdk-for-go/api/service/codedeploy/
    80  //
    81  // Using the Client
    82  //
    83  // To contact AWS CodeDeploy with the SDK use the New function to create
    84  // a new service client. With that client you can make API requests to the service.
    85  // These clients are safe to use concurrently.
    86  //
    87  // See the SDK's documentation for more information on how to use the SDK.
    88  // https://docs.aws.amazon.com/sdk-for-go/api/
    89  //
    90  // See aws.Config documentation for more information on configuring SDK clients.
    91  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    92  //
    93  // See the AWS CodeDeploy client CodeDeploy for more
    94  // information on creating client for this service.
    95  // https://docs.aws.amazon.com/sdk-for-go/api/service/codedeploy/#New
    96  package codedeploy