CodeStarconnections class

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.

Constructors

CodeStarconnections({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createConnection({required String connectionName, String? hostArn, ProviderType? providerType, List<Tag>? tags}) → Future<CreateConnectionOutput>

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({required String name, required String providerEndpoint, required ProviderType providerType, VpcConfiguration? vpcConfiguration}) → Future<CreateHostOutput>

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.

deleteConnection({required String connectionArn}) → Future<void>

The connection to be deleted.

deleteHost({required String hostArn}) → Future<void>

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

getConnection({required String connectionArn}) → Future<GetConnectionOutput>

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

getHost({required String hostArn}) → Future<GetHostOutput>

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

listConnections({String? hostArnFilter, int? maxResults, String? nextToken, ProviderType? providerTypeFilter}) → Future<ListConnectionsOutput>

Lists the connections associated with your account.

listHosts({int? maxResults, String? nextToken}) → Future<ListHostsOutput>

Lists the hosts associated with your account.

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceOutput>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>

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

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Removes tags from an AWS resource.

updateHost({required String hostArn, String? providerEndpoint, VpcConfiguration? vpcConfiguration}) → Future<void>

Updates a specified host with the provided configurations.

Operators

operator ==(Object other) → bool

The equality operator.

inherited