1. Packages
  2. Google Cloud Native
  3. API Docs
  4. storagetransfer
  5. storagetransfer/v1
  6. AgentPool

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.storagetransfer/v1.AgentPool

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Creates an agent pool resource.

    Create AgentPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AgentPool(name: string, args: AgentPoolArgs, opts?: CustomResourceOptions);
    @overload
    def AgentPool(resource_name: str,
                  args: AgentPoolArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def AgentPool(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  agent_pool_id: Optional[str] = None,
                  bandwidth_limit: Optional[BandwidthLimitArgs] = None,
                  display_name: Optional[str] = None,
                  name: Optional[str] = None,
                  project: Optional[str] = None)
    func NewAgentPool(ctx *Context, name string, args AgentPoolArgs, opts ...ResourceOption) (*AgentPool, error)
    public AgentPool(string name, AgentPoolArgs args, CustomResourceOptions? opts = null)
    public AgentPool(String name, AgentPoolArgs args)
    public AgentPool(String name, AgentPoolArgs args, CustomResourceOptions options)
    
    type: google-native:storagetransfer/v1:AgentPool
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AgentPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AgentPoolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AgentPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var agentPoolResource = new GoogleNative.StorageTransfer.V1.AgentPool("agentPoolResource", new()
    {
        AgentPoolId = "string",
        BandwidthLimit = new GoogleNative.StorageTransfer.V1.Inputs.BandwidthLimitArgs
        {
            LimitMbps = "string",
        },
        DisplayName = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := storagetransfer.NewAgentPool(ctx, "agentPoolResource", &storagetransfer.AgentPoolArgs{
    AgentPoolId: pulumi.String("string"),
    BandwidthLimit: &storagetransfer.BandwidthLimitArgs{
    LimitMbps: pulumi.String("string"),
    },
    DisplayName: pulumi.String("string"),
    Name: pulumi.String("string"),
    Project: pulumi.String("string"),
    })
    
    var agentPoolResource = new AgentPool("agentPoolResource", AgentPoolArgs.builder()
        .agentPoolId("string")
        .bandwidthLimit(BandwidthLimitArgs.builder()
            .limitMbps("string")
            .build())
        .displayName("string")
        .name("string")
        .project("string")
        .build());
    
    agent_pool_resource = google_native.storagetransfer.v1.AgentPool("agentPoolResource",
        agent_pool_id="string",
        bandwidth_limit=google_native.storagetransfer.v1.BandwidthLimitArgs(
            limit_mbps="string",
        ),
        display_name="string",
        name="string",
        project="string")
    
    const agentPoolResource = new google_native.storagetransfer.v1.AgentPool("agentPoolResource", {
        agentPoolId: "string",
        bandwidthLimit: {
            limitMbps: "string",
        },
        displayName: "string",
        name: "string",
        project: "string",
    });
    
    type: google-native:storagetransfer/v1:AgentPool
    properties:
        agentPoolId: string
        bandwidthLimit:
            limitMbps: string
        displayName: string
        name: string
        project: string
    

    AgentPool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AgentPool resource accepts the following input properties:

    AgentPoolId string
    Required. The ID of the agent pool to create. The agent_pool_id 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]([a-z0-9-._~]*[a-z0-9])?$.
    BandwidthLimit Pulumi.GoogleNative.StorageTransfer.V1.Inputs.BandwidthLimit
    Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
    DisplayName string
    Specifies the client-specified AgentPool description.
    Name string
    Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
    Project string
    AgentPoolId string
    Required. The ID of the agent pool to create. The agent_pool_id 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]([a-z0-9-._~]*[a-z0-9])?$.
    BandwidthLimit BandwidthLimitArgs
    Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
    DisplayName string
    Specifies the client-specified AgentPool description.
    Name string
    Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
    Project string
    agentPoolId String
    Required. The ID of the agent pool to create. The agent_pool_id 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]([a-z0-9-._~]*[a-z0-9])?$.
    bandwidthLimit BandwidthLimit
    Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
    displayName String
    Specifies the client-specified AgentPool description.
    name String
    Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
    project String
    agentPoolId string
    Required. The ID of the agent pool to create. The agent_pool_id 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]([a-z0-9-._~]*[a-z0-9])?$.
    bandwidthLimit BandwidthLimit
    Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
    displayName string
    Specifies the client-specified AgentPool description.
    name string
    Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
    project string
    agent_pool_id str
    Required. The ID of the agent pool to create. The agent_pool_id 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]([a-z0-9-._~]*[a-z0-9])?$.
    bandwidth_limit BandwidthLimitArgs
    Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
    display_name str
    Specifies the client-specified AgentPool description.
    name str
    Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
    project str
    agentPoolId String
    Required. The ID of the agent pool to create. The agent_pool_id 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]([a-z0-9-._~]*[a-z0-9])?$.
    bandwidthLimit Property Map
    Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
    displayName String
    Specifies the client-specified AgentPool description.
    name String
    Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AgentPool resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Specifies the state of the AgentPool.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Specifies the state of the AgentPool.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Specifies the state of the AgentPool.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    Specifies the state of the AgentPool.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    Specifies the state of the AgentPool.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Specifies the state of the AgentPool.

    Supporting Types

    BandwidthLimit, BandwidthLimitArgs

    LimitMbps string
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    LimitMbps string
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    limitMbps String
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    limitMbps string
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    limit_mbps str
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    limitMbps String
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.

    BandwidthLimitResponse, BandwidthLimitResponseArgs

    LimitMbps string
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    LimitMbps string
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    limitMbps String
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    limitMbps string
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    limit_mbps str
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
    limitMbps String
    Bandwidth rate in megabytes per second, distributed across all the agents in the pool.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi