codedeploy/aws.sdk.kotlin.services.codedeploy

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

addTagsToOnPremisesInstances

inline suspend fun CodeDeployClient.addTagsToOnPremisesInstances(crossinline block: AddTagsToOnPremisesInstancesRequest.Builder.() -> Unit): AddTagsToOnPremisesInstancesResponse

Adds tags to on-premises instances.

batchGetApplicationRevisions

inline suspend fun CodeDeployClient.batchGetApplicationRevisions(crossinline block: BatchGetApplicationRevisionsRequest.Builder.() -> Unit): BatchGetApplicationRevisionsResponse

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

batchGetApplications

inline suspend fun CodeDeployClient.batchGetApplications(crossinline block: BatchGetApplicationsRequest.Builder.() -> Unit): BatchGetApplicationsResponse

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

batchGetDeploymentGroups

inline suspend fun CodeDeployClient.batchGetDeploymentGroups(crossinline block: BatchGetDeploymentGroupsRequest.Builder.() -> Unit): BatchGetDeploymentGroupsResponse

Gets information about one or more deployment groups.

batchGetDeploymentInstances

inline suspend fun CodeDeployClient.~~batchGetDeploymentInstances~~(crossinline block: BatchGetDeploymentInstancesRequest.Builder.() -> Unit): BatchGetDeploymentInstancesResponse

This method works, but is deprecated. Use BatchGetDeploymentTargets instead.

batchGetDeployments

inline suspend fun CodeDeployClient.batchGetDeployments(crossinline block: BatchGetDeploymentsRequest.Builder.() -> Unit): BatchGetDeploymentsResponse

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

batchGetDeploymentTargets

inline suspend fun CodeDeployClient.batchGetDeploymentTargets(crossinline block: BatchGetDeploymentTargetsRequest.Builder.() -> Unit): BatchGetDeploymentTargetsResponse

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.

batchGetOnPremisesInstances

inline suspend fun CodeDeployClient.batchGetOnPremisesInstances(crossinline block: BatchGetOnPremisesInstancesRequest.Builder.() -> Unit): BatchGetOnPremisesInstancesResponse

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

continueDeployment

inline suspend fun CodeDeployClient.continueDeployment(crossinline block: ContinueDeploymentRequest.Builder.() -> Unit): ContinueDeploymentResponse

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

createApplication

inline suspend fun CodeDeployClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

Creates an application.

createDeployment

inline suspend fun CodeDeployClient.createDeployment(crossinline block: CreateDeploymentRequest.Builder.() -> Unit): CreateDeploymentResponse

Deploys an application revision through the specified deployment group.

createDeploymentConfig

inline suspend fun CodeDeployClient.createDeploymentConfig(crossinline block: CreateDeploymentConfigRequest.Builder.() -> Unit): CreateDeploymentConfigResponse

Creates a deployment configuration.

createDeploymentGroup

inline suspend fun CodeDeployClient.createDeploymentGroup(crossinline block: CreateDeploymentGroupRequest.Builder.() -> Unit): CreateDeploymentGroupResponse

Creates a deployment group to which application revisions are deployed.

deleteApplication

inline suspend fun CodeDeployClient.deleteApplication(crossinline block: DeleteApplicationRequest.Builder.() -> Unit): DeleteApplicationResponse

Deletes an application.

deleteDeploymentConfig

inline suspend fun CodeDeployClient.deleteDeploymentConfig(crossinline block: DeleteDeploymentConfigRequest.Builder.() -> Unit): DeleteDeploymentConfigResponse

Deletes a deployment configuration.

deleteDeploymentGroup

inline suspend fun CodeDeployClient.deleteDeploymentGroup(crossinline block: DeleteDeploymentGroupRequest.Builder.() -> Unit): DeleteDeploymentGroupResponse

Deletes a deployment group.

deleteGitHubAccountToken

inline suspend fun CodeDeployClient.deleteGitHubAccountToken(crossinline block: DeleteGitHubAccountTokenRequest.Builder.() -> Unit): DeleteGitHubAccountTokenResponse

Deletes a GitHub account connection.

deleteResourcesByExternalId

inline suspend fun CodeDeployClient.deleteResourcesByExternalId(crossinline block: DeleteResourcesByExternalIdRequest.Builder.() -> Unit): DeleteResourcesByExternalIdResponse

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

deregisterOnPremisesInstance

inline suspend fun CodeDeployClient.deregisterOnPremisesInstance(crossinline block: DeregisterOnPremisesInstanceRequest.Builder.() -> Unit): DeregisterOnPremisesInstanceResponse

Deregisters an on-premises instance.

getApplication

inline suspend fun CodeDeployClient.getApplication(crossinline block: GetApplicationRequest.Builder.() -> Unit): GetApplicationResponse

Gets information about an application.

getApplicationRevision

inline suspend fun CodeDeployClient.getApplicationRevision(crossinline block: GetApplicationRevisionRequest.Builder.() -> Unit): GetApplicationRevisionResponse

Gets information about an application revision.

getDeployment

inline suspend fun CodeDeployClient.getDeployment(crossinline block: GetDeploymentRequest.Builder.() -> Unit): GetDeploymentResponse

Gets information about a deployment.

getDeploymentConfig

inline suspend fun CodeDeployClient.getDeploymentConfig(crossinline block: GetDeploymentConfigRequest.Builder.() -> Unit): GetDeploymentConfigResponse

Gets information about a deployment configuration.

getDeploymentGroup

inline suspend fun CodeDeployClient.getDeploymentGroup(crossinline block: GetDeploymentGroupRequest.Builder.() -> Unit): GetDeploymentGroupResponse

Gets information about a deployment group.

getDeploymentInstance

inline suspend fun CodeDeployClient.~~getDeploymentInstance~~(crossinline block: GetDeploymentInstanceRequest.Builder.() -> Unit): GetDeploymentInstanceResponse

Gets information about an instance as part of a deployment.

getDeploymentTarget

inline suspend fun CodeDeployClient.getDeploymentTarget(crossinline block: GetDeploymentTargetRequest.Builder.() -> Unit): GetDeploymentTargetResponse

Returns information about a deployment target.

getOnPremisesInstance

inline suspend fun CodeDeployClient.getOnPremisesInstance(crossinline block: GetOnPremisesInstanceRequest.Builder.() -> Unit): GetOnPremisesInstanceResponse

Gets information about an on-premises instance.

listApplicationRevisions

inline suspend fun CodeDeployClient.listApplicationRevisions(crossinline block: ListApplicationRevisionsRequest.Builder.() -> Unit): ListApplicationRevisionsResponse

Lists information about revisions for an application.

listApplications

inline suspend fun CodeDeployClient.listApplications(crossinline block: ListApplicationsRequest.Builder.() -> Unit): ListApplicationsResponse

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

listDeploymentConfigs

inline suspend fun CodeDeployClient.listDeploymentConfigs(crossinline block: ListDeploymentConfigsRequest.Builder.() -> Unit): ListDeploymentConfigsResponse

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

listDeploymentGroups

inline suspend fun CodeDeployClient.listDeploymentGroups(crossinline block: ListDeploymentGroupsRequest.Builder.() -> Unit): ListDeploymentGroupsResponse

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

listDeploymentInstances

inline suspend fun CodeDeployClient.~~listDeploymentInstances~~(crossinline block: ListDeploymentInstancesRequest.Builder.() -> Unit): ListDeploymentInstancesResponse

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.

listDeployments

inline suspend fun CodeDeployClient.listDeployments(crossinline block: ListDeploymentsRequest.Builder.() -> Unit): ListDeploymentsResponse

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

listDeploymentTargets

inline suspend fun CodeDeployClient.listDeploymentTargets(crossinline block: ListDeploymentTargetsRequest.Builder.() -> Unit): ListDeploymentTargetsResponse

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

listGitHubAccountTokenNames

inline suspend fun CodeDeployClient.listGitHubAccountTokenNames(crossinline block: ListGitHubAccountTokenNamesRequest.Builder.() -> Unit): ListGitHubAccountTokenNamesResponse

Lists the names of stored connections to GitHub accounts.

listOnPremisesInstances

inline suspend fun CodeDeployClient.listOnPremisesInstances(crossinline block: ListOnPremisesInstancesRequest.Builder.() -> Unit): ListOnPremisesInstancesResponse

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

listTagsForResource

inline suspend fun CodeDeployClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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.

putLifecycleEventHookExecutionStatus

inline suspend fun CodeDeployClient.putLifecycleEventHookExecutionStatus(crossinline block: PutLifecycleEventHookExecutionStatusRequest.Builder.() -> Unit): PutLifecycleEventHookExecutionStatusResponse

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.

registerApplicationRevision

inline suspend fun CodeDeployClient.registerApplicationRevision(crossinline block: RegisterApplicationRevisionRequest.Builder.() -> Unit): RegisterApplicationRevisionResponse

Registers with CodeDeploy a revision for the specified application.

registerOnPremisesInstance

inline suspend fun CodeDeployClient.registerOnPremisesInstance(crossinline block: RegisterOnPremisesInstanceRequest.Builder.() -> Unit): RegisterOnPremisesInstanceResponse

Registers an on-premises instance.

removeTagsFromOnPremisesInstances

inline suspend fun CodeDeployClient.removeTagsFromOnPremisesInstances(crossinline block: RemoveTagsFromOnPremisesInstancesRequest.Builder.() -> Unit): RemoveTagsFromOnPremisesInstancesResponse

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

skipWaitTimeForInstanceTermination

inline suspend fun CodeDeployClient.~~skipWaitTimeForInstanceTermination~~(crossinline block: SkipWaitTimeForInstanceTerminationRequest.Builder.() -> Unit): SkipWaitTimeForInstanceTerminationResponse

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

stopDeployment

inline suspend fun CodeDeployClient.stopDeployment(crossinline block: StopDeploymentRequest.Builder.() -> Unit): StopDeploymentResponse

Attempts to stop an ongoing deployment.

tagResource

inline suspend fun CodeDeployClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.

untagResource

inline suspend fun CodeDeployClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

updateApplication

inline suspend fun CodeDeployClient.updateApplication(crossinline block: UpdateApplicationRequest.Builder.() -> Unit): UpdateApplicationResponse

Changes the name of an application.

updateDeploymentGroup

inline suspend fun CodeDeployClient.updateDeploymentGroup(crossinline block: UpdateDeploymentGroupRequest.Builder.() -> Unit): UpdateDeploymentGroupResponse

Changes information about a deployment group.

withConfig

fun CodeDeployClient.withConfig(block: CodeDeployClient.Config.Builder.() -> Unit): CodeDeployClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.