/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodeStarConnections

NAME

Paws::CodeStarConnections - Perl Interface to AWS AWS CodeStar connections

SYNOPSIS

use Paws;

my $obj = Paws->service('CodeStarConnections');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

AWS CodeStar Connections

This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Connections API. You can use the connections API to work with connections and installations.

Connections are configurations that you use to connect AWS 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 AWS CodeStar Connections by calling the following:

  • ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeStar Connections.

  • TagResource, which adds or updates tags for a resource in AWS CodeStar Connections.

  • UntagResource, which removes tags for a resource in AWS CodeStar Connections.

For information about how to use AWS CodeStar Connections, see the Developer Tools User Guide (https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01

METHODS

CreateConnection

ConnectionName => Str
[HostArn => Str]
[ProviderType => Str]
[Tags => ArrayRef[Paws::CodeStarConnections::Tag]]

Each argument is described in detail in: Paws::CodeStarConnections::CreateConnection

Returns: a Paws::CodeStarConnections::CreateConnectionOutput instance

Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.

CreateHost

Name => Str
ProviderEndpoint => Str
ProviderType => Str
[Tags => ArrayRef[Paws::CodeStarConnections::Tag]]
[VpcConfiguration => Paws::CodeStarConnections::VpcConfiguration]

Each argument is described in detail in: Paws::CodeStarConnections::CreateHost

Returns: a Paws::CodeStarConnections::CreateHostOutput instance

Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console.

DeleteConnection

ConnectionArn => Str

Each argument is described in detail in: Paws::CodeStarConnections::DeleteConnection

Returns: a Paws::CodeStarConnections::DeleteConnectionOutput instance

The connection to be deleted.

DeleteHost

HostArn => Str

Each argument is described in detail in: Paws::CodeStarConnections::DeleteHost

Returns: a Paws::CodeStarConnections::DeleteHostOutput instance

The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.

A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

GetConnection

ConnectionArn => Str

Each argument is described in detail in: Paws::CodeStarConnections::GetConnection

Returns: a Paws::CodeStarConnections::GetConnectionOutput instance

Returns the connection ARN and details such as status, owner, and provider type.

GetHost

HostArn => Str

Each argument is described in detail in: Paws::CodeStarConnections::GetHost

Returns: a Paws::CodeStarConnections::GetHostOutput instance

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.

ListConnections

[HostArnFilter => Str]
[MaxResults => Int]
[NextToken => Str]
[ProviderTypeFilter => Str]

Each argument is described in detail in: Paws::CodeStarConnections::ListConnections

Returns: a Paws::CodeStarConnections::ListConnectionsOutput instance

Lists the connections associated with your account.

ListHosts

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeStarConnections::ListHosts

Returns: a Paws::CodeStarConnections::ListHostsOutput instance

Lists the hosts associated with your account.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::CodeStarConnections::ListTagsForResource

Returns: a Paws::CodeStarConnections::ListTagsForResourceOutput instance

Gets the set of key-value pairs (metadata) that are used to manage the resource.

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::CodeStarConnections::Tag]

Each argument is described in detail in: Paws::CodeStarConnections::TagResource

Returns: a Paws::CodeStarConnections::TagResourceOutput instance

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeStarConnections::UntagResource

Returns: a Paws::CodeStarConnections::UntagResourceOutput instance

Removes tags from an AWS resource.

UpdateHost

HostArn => Str
[ProviderEndpoint => Str]
[VpcConfiguration => Paws::CodeStarConnections::VpcConfiguration]

Each argument is described in detail in: Paws::CodeStarConnections::UpdateHost

Returns: a Paws::CodeStarConnections::UpdateHostOutput instance

Updates a specified host with the provided configurations.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues