Skip to content

googleStorageTransferAgentPool

Represents an On-Premises Agent pool.

To get more information about AgentPool, see:

Example Usage - Agent Pool Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const dataGoogleStorageTransferProjectServiceAccountDefault =
  new google.dataGoogleStorageTransferProjectServiceAccount.DataGoogleStorageTransferProjectServiceAccount(
    this,
    "default",
    {
      project: "my-project-name",
    }
  );
const googleProjectIamMemberPubsubEditorRole =
  new google.projectIamMember.ProjectIamMember(this, "pubsub_editor_role", {
    member: `serviceAccount:\${${dataGoogleStorageTransferProjectServiceAccountDefault.email}}`,
    project: "my-project-name",
    role: "roles/pubsub.editor",
  });
new google.storageTransferAgentPool.StorageTransferAgentPool(this, "example", {
  bandwidth_limit: [
    {
      limit_mbps: "120",
    },
  ],
  depends_on: [`\${${googleProjectIamMemberPubsubEditorRole.fqn}}`],
  display_name: "Source A to destination Z",
  name: "agent-pool-example",
});

Argument Reference

The following arguments are supported:

  • name - (Required) 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?$.

  • displayName - (Optional) Specifies the client-specified AgentPool description.

  • bandwidthLimit - (Optional) Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. Structure is documented below.

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The bandwidthLimit block supports:

  • limitMbps - (Required) Bandwidth rate in megabytes per second, distributed across all the agents in the pool.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/{{project}}/agentPools/{{name}}

  • state - Specifies the state of the AgentPool.

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 30 minutes.
  • update - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

AgentPool can be imported using any of these accepted formats:

$ terraform import google_storage_transfer_agent_pool.default projects/{{project}}/agentPools/{{name}}
$ terraform import google_storage_transfer_agent_pool.default {{project}}/{{name}}
$ terraform import google_storage_transfer_agent_pool.default {{name}}

User Project Overrides

This resource supports User Project Overrides.