@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
182 lines (181 loc) • 7.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Represents an On-Premises Agent pool.
*
* To get more information about AgentPool, see:
*
* * [API documentation](https://cloud.google.com/storage-transfer/docs/reference/rest/v1/projects.agentPools)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/storage-transfer/docs/on-prem-agent-pools)
*
* ## Example Usage
*
* ### Agent Pool Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.storage.getTransferProjectServiceAccount({
* project: "my-project-name",
* });
* const pubsubEditorRole = new gcp.projects.IAMMember("pubsub_editor_role", {
* project: "my-project-name",
* role: "roles/pubsub.editor",
* member: _default.then(_default => `serviceAccount:${_default.email}`),
* });
* const example = new gcp.storage.TransferAgentPool("example", {
* name: "agent-pool-example",
* displayName: "Source A to destination Z",
* bandwidthLimit: {
* limitMbps: "120",
* },
* }, {
* dependsOn: [pubsubEditorRole],
* });
* ```
*
* ## Import
*
* AgentPool can be imported using any of these accepted formats:
*
* * `projects/{{project}}/agentPools/{{name}}`
*
* * `{{project}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, AgentPool can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:storage/transferAgentPool:TransferAgentPool default projects/{{project}}/agentPools/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:storage/transferAgentPool:TransferAgentPool default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:storage/transferAgentPool:TransferAgentPool default {{name}}
* ```
*/
export declare class TransferAgentPool extends pulumi.CustomResource {
/**
* Get an existing TransferAgentPool 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?: TransferAgentPoolState, opts?: pulumi.CustomResourceOptions): TransferAgentPool;
/**
* Returns true if the given object is an instance of TransferAgentPool. 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 TransferAgentPool;
/**
* Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
* Structure is documented below.
*/
readonly bandwidthLimit: pulumi.Output<outputs.storage.TransferAgentPoolBandwidthLimit | undefined>;
/**
* Specifies the client-specified AgentPool description.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* The ID of the agent pool to create.
* The agentPoolId must meet the following requirements:
* * Length of 128 characters or less.
* * Not start with the string goog.
* * Start with a lowercase ASCII character, followed by:
* * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (-), periods (.), underscores (_), or tildes (~).
* * One or more numerals or lowercase ASCII characters.
* As expressed by the regular expression: ^(?!goog)a-z?$.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Specifies the state of the AgentPool.
*/
readonly state: pulumi.Output<string>;
/**
* Create a TransferAgentPool 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?: TransferAgentPoolArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TransferAgentPool resources.
*/
export interface TransferAgentPoolState {
/**
* Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
* Structure is documented below.
*/
bandwidthLimit?: pulumi.Input<inputs.storage.TransferAgentPoolBandwidthLimit>;
/**
* Specifies the client-specified AgentPool description.
*/
displayName?: pulumi.Input<string>;
/**
* The ID of the agent pool to create.
* The agentPoolId must meet the following requirements:
* * Length of 128 characters or less.
* * Not start with the string goog.
* * Start with a lowercase ASCII character, followed by:
* * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (-), periods (.), underscores (_), or tildes (~).
* * One or more numerals or lowercase ASCII characters.
* As expressed by the regular expression: ^(?!goog)a-z?$.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* Specifies the state of the AgentPool.
*/
state?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TransferAgentPool resource.
*/
export interface TransferAgentPoolArgs {
/**
* Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
* Structure is documented below.
*/
bandwidthLimit?: pulumi.Input<inputs.storage.TransferAgentPoolBandwidthLimit>;
/**
* Specifies the client-specified AgentPool description.
*/
displayName?: pulumi.Input<string>;
/**
* The ID of the agent pool to create.
* The agentPoolId must meet the following requirements:
* * Length of 128 characters or less.
* * Not start with the string goog.
* * Start with a lowercase ASCII character, followed by:
* * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (-), periods (.), underscores (_), or tildes (~).
* * One or more numerals or lowercase ASCII characters.
* As expressed by the regular expression: ^(?!goog)a-z?$.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}