software.amazon.awssdk.services.codestarconnections.package-info Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
/**
* AWS CodeStar Connections
*
* This Amazon Web Services CodeStar Connections API Reference provides descriptions and usage examples of the
* operations and data types for the Amazon Web Services CodeStar Connections API. You can use the connections API to
* work with connections and installations.
*
*
* Connections are configurations that you use to connect Amazon Web Services resources to external code
* repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a
* third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers
* your pipeline when a code change is made to your third-party code repository. Each connection is named and associated
* with a unique ARN that is used to reference the connection.
*
*
* When you create a connection, the console initiates a third-party connection handshake. Installations are the
* apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the
* Bitbucket app. When you create a connection, you can choose an existing installation or create one.
*
*
* When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a
* host for your connections.
*
*
* You can work with connections by calling:
*
*
* -
*
* CreateConnection, which creates a uniquely named connection that can be referenced by services such as
* CodePipeline.
*
*
* -
*
* DeleteConnection, which deletes the specified connection.
*
*
* -
*
* GetConnection, which returns information about the connection, including the connection status.
*
*
* -
*
* ListConnections, which lists the connections associated with your account.
*
*
*
*
* You can work with hosts by calling:
*
*
* -
*
* CreateHost, which creates a host that represents the infrastructure where your provider is installed.
*
*
* -
*
* DeleteHost, which deletes the specified host.
*
*
* -
*
* GetHost, which returns information about the host, including the setup status.
*
*
* -
*
* ListHosts, which lists the hosts associated with your account.
*
*
*
*
* You can work with tags in Amazon Web Services CodeStar Connections by calling the following:
*
*
* -
*
* ListTagsForResource, which gets information about Amazon Web Services tags for a specified Amazon Resource
* Name (ARN) in Amazon Web Services CodeStar Connections.
*
*
* -
*
* TagResource, which adds or updates tags for a resource in Amazon Web Services CodeStar Connections.
*
*
* -
*
* UntagResource, which removes tags for a resource in Amazon Web Services CodeStar Connections.
*
*
*
*
* For information about how to use Amazon Web Services CodeStar Connections, see the Developer Tools User
* Guide.
*
*/
package software.amazon.awssdk.services.codestarconnections;