@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
192 lines (191 loc) • 7.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a AWS service endpoint within Azure DevOps. Using this service endpoint requires you to first install [AWS Toolkit for Azure DevOps](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-vsts-tools).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuredevops from "@pulumi/azuredevops";
*
* const example = new azuredevops.Project("example", {
* name: "Example Project",
* visibility: "private",
* versionControl: "Git",
* workItemTemplate: "Agile",
* description: "Managed by Pulumi",
* });
* const exampleServiceEndpointAws = new azuredevops.ServiceEndpointAws("example", {
* projectId: example.id,
* serviceEndpointName: "Example AWS",
* accessKeyId: "00000000-0000-0000-0000-000000000000",
* secretAccessKey: "accesskey",
* description: "Managed by AzureDevOps",
* });
* ```
*
* ## Relevant Links
*
* * [aws-toolkit-azure-devops](https://github.com/aws/aws-toolkit-azure-devops)
* * [Azure DevOps Service REST API 7.0 - Agent Pools](https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints?view=azure-devops-rest-7.0)
*
* ## Import
*
* Azure DevOps AWS Service Endpoint can be imported using **projectID/serviceEndpointID** or **projectName/serviceEndpointID**
*
* ```sh
* $ pulumi import azuredevops:index/serviceEndpointAws:ServiceEndpointAws azuredevops_serviceendpoint_aws.example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
* ```
*/
export declare class ServiceEndpointAws extends pulumi.CustomResource {
/**
* Get an existing ServiceEndpointAws resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceEndpointAwsState, opts?: pulumi.CustomResourceOptions): ServiceEndpointAws;
/**
* Returns true if the given object is an instance of ServiceEndpointAws. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ServiceEndpointAws;
/**
* The AWS access key ID for signing programmatic requests.
*/
readonly accessKeyId: pulumi.Output<string | undefined>;
readonly authorization: pulumi.Output<{
[key: string]: string;
}>;
readonly description: pulumi.Output<string | undefined>;
/**
* A unique identifier that is used by third parties when assuming roles in their customers' accounts, aka cross-account role access.
*/
readonly externalId: pulumi.Output<string | undefined>;
/**
* The ID of the project.
*/
readonly projectId: pulumi.Output<string>;
/**
* Optional identifier for the assumed role session.
*/
readonly roleSessionName: pulumi.Output<string | undefined>;
/**
* The Amazon Resource Name (ARN) of the role to assume.
*/
readonly roleToAssume: pulumi.Output<string | undefined>;
/**
* The AWS secret access key for signing programmatic requests.
*/
readonly secretAccessKey: pulumi.Output<string | undefined>;
/**
* The Service Endpoint name.
*/
readonly serviceEndpointName: pulumi.Output<string>;
/**
* The AWS session token for signing programmatic requests.
*/
readonly sessionToken: pulumi.Output<string | undefined>;
/**
* Enable this to attempt getting credentials with OIDC token from Azure Devops.
*/
readonly useOidc: pulumi.Output<boolean | undefined>;
/**
* Create a ServiceEndpointAws resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ServiceEndpointAwsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServiceEndpointAws resources.
*/
export interface ServiceEndpointAwsState {
/**
* The AWS access key ID for signing programmatic requests.
*/
accessKeyId?: pulumi.Input<string>;
authorization?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
/**
* A unique identifier that is used by third parties when assuming roles in their customers' accounts, aka cross-account role access.
*/
externalId?: pulumi.Input<string>;
/**
* The ID of the project.
*/
projectId?: pulumi.Input<string>;
/**
* Optional identifier for the assumed role session.
*/
roleSessionName?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) of the role to assume.
*/
roleToAssume?: pulumi.Input<string>;
/**
* The AWS secret access key for signing programmatic requests.
*/
secretAccessKey?: pulumi.Input<string>;
/**
* The Service Endpoint name.
*/
serviceEndpointName?: pulumi.Input<string>;
/**
* The AWS session token for signing programmatic requests.
*/
sessionToken?: pulumi.Input<string>;
/**
* Enable this to attempt getting credentials with OIDC token from Azure Devops.
*/
useOidc?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a ServiceEndpointAws resource.
*/
export interface ServiceEndpointAwsArgs {
/**
* The AWS access key ID for signing programmatic requests.
*/
accessKeyId?: pulumi.Input<string>;
description?: pulumi.Input<string>;
/**
* A unique identifier that is used by third parties when assuming roles in their customers' accounts, aka cross-account role access.
*/
externalId?: pulumi.Input<string>;
/**
* The ID of the project.
*/
projectId: pulumi.Input<string>;
/**
* Optional identifier for the assumed role session.
*/
roleSessionName?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) of the role to assume.
*/
roleToAssume?: pulumi.Input<string>;
/**
* The AWS secret access key for signing programmatic requests.
*/
secretAccessKey?: pulumi.Input<string>;
/**
* The Service Endpoint name.
*/
serviceEndpointName: pulumi.Input<string>;
/**
* The AWS session token for signing programmatic requests.
*/
sessionToken?: pulumi.Input<string>;
/**
* Enable this to attempt getting credentials with OIDC token from Azure Devops.
*/
useOidc?: pulumi.Input<boolean>;
}