doc.go 5.1 KB

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