本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CodeConnections 使用示例 Amazon CLI
以下代码示例向您展示了如何使用with来执行操作和实现常见场景 CodeConnections。 Amazon Command Line Interface
操作是大型程序的代码摘录,必须在上下文中运行。您可以通过操作了解如何调用单个服务函数,还可以通过函数相关场景和跨服务示例的上下文查看操作。
场景是展示如何通过在同一服务中调用多个函数来完成特定任务任务的代码示例。
每个示例都包含一个指向的链接 GitHub,您可以在其中找到有关如何在上下文中设置和运行代码的说明。
主题
操作
以下代码示例演示如何使用 create-connection
。
- Amazon CLI
-
创建连接
以下
create-connection
示例说明如何创建与第三方存储库的连接。此示例创建了一个连接,其中第三方提供商是 Bitbucket。通过 Amazon CLI 创建的连接或默认 Amazon CloudFormation 处于待处理状态。使用 CLI 或创建连接后 Amazon CloudFormation,使用控制台编辑连接以使其状态变为 “可用”。
aws codestar-connections create-connection \ --provider-type Bitbucket \ --connection-name MyConnection
输出:
{ "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f" }
有关更多信息,请参阅《开发者工具控制台用户指南》中的创建连接。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考CreateConnection
中的。
-
以下代码示例演示如何使用 create-host
。
- Amazon CLI
-
创建主机
以下
create-host
示例说明如何创建主机来表示安装第三方提供商的基础架构的终端节点。此示例创建了一台主机,其中安装的第三方提供商是 GitHub 企业服务器。默认情况下,通过 Amazon CLI 创建的主机处于待处理状态。使用 CLI 创建主机后,使用控制台或 CLI 将主机设置为可用状态。
aws codestar-connections create-host \ --name MyHost \ --provider-type GitHubEnterpriseServer \ --provider-endpoint "https://my-instance.dev"
输出:
{ "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605" }
有关更多信息,请参阅《开发者工具控制台用户指南》中的创建主机 (CLI)。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考CreateHost
中的。
-
以下代码示例演示如何使用 delete-connection
。
- Amazon CLI
-
删除连接
以下
delete-connection
示例说明如何删除连接。aws codestar-connections delete-connection \ --connection-arn arn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f
此命令不生成任何输出。
有关更多信息,请参阅《开发者工具控制台用户指南》中的删除连接 (CLI)。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考DeleteConnection
中的。
-
以下代码示例演示如何使用 delete-host
。
- Amazon CLI
-
删除主机
以下
delete-host
示例说明如何删除主机。必须先删除与主机关联的所有连接,然后才能删除主机。aws codestar-connections delete-host \ --host-arn "arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605"
此命令不生成任何输出。
有关更多信息,请参阅《开发者工具控制台用户指南》中的删除主机 (CLI)。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考DeleteHost
中的。
-
以下代码示例演示如何使用 get-connection
。
- Amazon CLI
-
获取有关连接的信息
以下
get-connection
示例显示了有关连接的详细信息。aws codestar-connections get-connection \ --connection-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f
输出:
{ "Connection": { "ConnectionName": "MyConnection", "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f", "ProviderType": "Bitbucket", "OwnerAccountId": "123456789012", "ConnectionStatus": "AVAILABLE" } }
有关更多信息,请参阅《开发者工具控制台用户指南》中的 “查看连接详情”。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考GetConnection
中的。
-
以下代码示例演示如何使用 get-host
。
- Amazon CLI
-
获取有关房东的信息
以下
get-host
示例显示了有关主机的详细信息:aws codestar-connections get-host \ --host-arn arn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605
输出:
{ "Name": "MyHost", "Status": "AVAILABLE", "ProviderType": "GitHubEnterpriseServer", "ProviderEndpoint": "https://test-instance-1.dev/" }
有关更多信息,请参阅《开发者工具控制台用户指南》中的查看主机详细信息 (CLI)。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考GetHost
中的。
-
以下代码示例演示如何使用 list-connections
。
- Amazon CLI
-
列出连接
以下
list-connections
示例检索您账户中与 Bitbucket 提供商类型对应的所有连接的列表。 :aws codestar-connections list-connections \ --provider-type Bitbucket \ --max-results 5 \ --next-token: next-token
输出:
{ "Connections": [ { "ConnectionName": "my-connection", "ProviderType": "Bitbucket", "Status": "PENDING", "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f", "OwnerAccountId": "123456789012" }, { "ConnectionName": "my-other-connection", "ProviderType": "Bitbucket", "Status": "AVAILABLE", "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f", "OwnerAccountId": "123456789012" }, ], "NextToken": "next-token" }
有关更多信息,请参阅《开发者工具控制台用户指南》中的列出连接 (CLI)。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListConnections
中的。
-
以下代码示例演示如何使用 list-hosts
。
- Amazon CLI
-
列出房东
以下
list-hosts
示例检索您账户中所有主机的列表。aws codestar-connections list-hosts
输出:
{ "Hosts": [ { "Name": "My-Host", "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605", "ProviderType": "GitHubEnterpriseServer", "ProviderEndpoint": "https://my-instance.test.dev", "Status": "AVAILABLE" } ] }
有关更多信息,请参阅《开发者工具控制台用户指南》中的列出主机 (CLI)。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListHosts
中的。
-
以下代码示例演示如何使用 list-tags-for-resource
。
- Amazon CLI
-
列出标签
以下
list-tags-for-resource
示例检索附加到指定连接资源的所有标签的列表。aws codestar-connections list-tags-for-resource \ --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f
输出:
{ "Tags": [ { "Key": "Project", "Value": "ProjectA" }, { "Key": "ReadOnly", "Value": "true" } ] }
有关更多信息,请参阅《开发者工具控制台用户指南》中的查看连接资源的标签。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListTagsForResource
中的。
-
以下代码示例演示如何使用 tag-resource
。
- Amazon CLI
-
为资源添加标签
以下
tag-resource
示例将一组提供的标签与连接相关联。使用此命令添加或编辑标签。aws codestar-connections tag-resource \ --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \ --tags Key=Project,Value=ProjectA Key=IscontainerBased,Value=true
此命令不生成任何输出。
有关更多信息,请参阅《开发者工具控制台用户指南》中的向连接资源添加标签。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考TagResource
中的。
-
以下代码示例演示如何使用 untag-resource
。
- Amazon CLI
-
从连接资源中移除 Amazon 标签
以下内容从指定资源中
untag-resource
删除标签。aws codestar-connections untag-resource \ --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \ --tag-keys Project ReadOnly
输出:
{ "Tags": [] }
有关更多信息,请参阅《开发者工具控制台用户指南》中的从连接资源中移除标签。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考UntagResource
中的。
-