TransferAgentPool class

Represents an On-Premises Agent pool.

To get more information about AgentPool, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Agent Pool Basic

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 pulumi
import pulumi_gcp as gcp

default = gcp.storage.get_transfer_project_service_account(project="my-project-name")
pubsub_editor_role = gcp.projects.IAMMember("pubsub_editor_role",
    project="my-project-name",
    role="roles/pubsub.editor",
    member=f"serviceAccount:{default.email}")
example = gcp.storage.TransferAgentPool("example",
    name="agent-pool-example",
    display_name="Source A to destination Z",
    bandwidth_limit={
        "limit_mbps": "120",
    },
    opts = pulumi.ResourceOptions(depends_on=[pubsub_editor_role]))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var @default = Gcp.Storage.GetTransferProjectServiceAccount.Invoke(new()
    {
        Project = "my-project-name",
    });

    var pubsubEditorRole = new Gcp.Projects.IAMMember("pubsub_editor_role", new()
    {
        Project = "my-project-name",
        Role = "roles/pubsub.editor",
        Member = @default.Apply(@default => $"serviceAccount:{@default.Apply(getTransferProjectServiceAccountResult => getTransferProjectServiceAccountResult.Email)}"),
    });

    var example = new Gcp.Storage.TransferAgentPool("example", new()
    {
        Name = "agent-pool-example",
        DisplayName = "Source A to destination Z",
        BandwidthLimit = new Gcp.Storage.Inputs.TransferAgentPoolBandwidthLimitArgs
        {
            LimitMbps = "120",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            pubsubEditorRole,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := storage.GetTransferProjectServiceAccount(ctx, &storage.GetTransferProjectServiceAccountArgs{
			Project: pulumi.StringRef("my-project-name"),
		}, nil)
		if err != nil {
			return err
		}
		pubsubEditorRole, err := projects.NewIAMMember(ctx, "pubsub_editor_role", &projects.IAMMemberArgs{
			Project: pulumi.String("my-project-name"),
			Role:    pulumi.String("roles/pubsub.editor"),
			Member:  pulumi.Sprintf("serviceAccount:%v", _default.Email),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewTransferAgentPool(ctx, "example", &storage.TransferAgentPoolArgs{
			Name:        pulumi.String("agent-pool-example"),
			DisplayName: pulumi.String("Source A to destination Z"),
			BandwidthLimit: &storage.TransferAgentPoolBandwidthLimitArgs{
				LimitMbps: pulumi.String("120"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			pubsubEditorRole,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_storage_gettransferprojectserviceaccount" "default" {
  project = "my-project-name"
}

resource "gcp_projects_iammember" "pubsub_editor_role" {
  project = "my-project-name"
  role    = "roles/pubsub.editor"
  member  ="serviceAccount:${data.gcp_storage_gettransferprojectserviceaccount.default.email}"
}
resource "gcp_storage_transferagentpool" "example" {
  depends_on   = [gcp_projects_iammember.pubsub_editor_role]
  name         = "agent-pool-example"
  display_name = "Source A to destination Z"
  bandwidth_limit = {
    limit_mbps = "120"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.StorageFunctions;
import com.pulumi.gcp.storage.inputs.GetTransferProjectServiceAccountArgs;
import com.pulumi.gcp.projects.IAMMember;
import com.pulumi.gcp.projects.IAMMemberArgs;
import com.pulumi.gcp.storage.TransferAgentPool;
import com.pulumi.gcp.storage.TransferAgentPoolArgs;
import com.pulumi.gcp.storage.inputs.TransferAgentPoolBandwidthLimitArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = StorageFunctions.getTransferProjectServiceAccount(GetTransferProjectServiceAccountArgs.builder()
            .project("my-project-name")
            .build());

        var pubsubEditorRole = new IAMMember("pubsubEditorRole", IAMMemberArgs.builder()
            .project("my-project-name")
            .role("roles/pubsub.editor")
            .member(String.format("serviceAccount:%s", default_.email()))
            .build());

        var example = new TransferAgentPool("example", TransferAgentPoolArgs.builder()
            .name("agent-pool-example")
            .displayName("Source A to destination Z")
            .bandwidthLimit(TransferAgentPoolBandwidthLimitArgs.builder()
                .limitMbps("120")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(pubsubEditorRole)
                .build());

    }
}

resources:
  pubsubEditorRole:
    type: gcp:projects:IAMMember
    name: pubsub_editor_role
    properties:
      project: my-project-name
      role: roles/pubsub.editor
      member: serviceAccount:${default.email}
  example:
    type: gcp:storage:TransferAgentPool
    properties:
      name: agent-pool-example
      displayName: Source A to destination Z
      bandwidthLimit:
        limitMbps: '120'
    options:
      dependsOn:
        - ${pubsubEditorRole}
variables:
  default:
    fn::invoke:
      function: gcp:storage:getTransferProjectServiceAccount
      arguments:
        project: my-project-name

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:

$ pulumi import gcp:storage/transferAgentPool:TransferAgentPool default projects/{{project}}/agentPools/{{name}}
$ pulumi import gcp:storage/transferAgentPool:TransferAgentPool default {{project}}/{{name}}
$ pulumi import gcp:storage/transferAgentPool:TransferAgentPool default {{name}}

Constructors

TransferAgentPool(String name, {TransferAgentPoolArgs? args, CustomResourceOptions? options})

Creates a new TransferAgentPool. name The Pulumi resource name. args Arguments used to configure this TransferAgentPool. The set of arguments for TransferAgentPool. options Resource options controlling this resource's behavior.

TransferAgentPool.reference(String urn)

Creates a typed reference to an existing TransferAgentPool resource.

Properties

bandwidthLimit ↔ Output<TransferAgentPoolBandwidthLimit?>

Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. Structure is documented below.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

displayName ↔ Output<String?>

Specifies the client-specified AgentPool description.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The ID of the agent pool to create. The agentPoolId must meet the following requirements:

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

Specifies the state of the AgentPool.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {TransferAgentPoolState? state, CustomResourceOptions? options}) → TransferAgentPool

Gets an existing TransferAgentPool resource's state with the given name and id.