1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. userAgent
Viewing docs for AWS v7.38.0
published on Tuesday, Jul 21, 2026 by Pulumi
aws logo
Viewing docs for AWS v7.38.0
published on Tuesday, Jul 21, 2026 by Pulumi

    Formats a User-Agent product for use with the userAgent argument in the provider block.

    Functions cannot be used in the terraform block, meaning this utility cannot be used with the providerMeta userAgent argument.

    Signature

    user_agent(product_name string, product_version string, comment string) string
    

    Using userAgent

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function userAgent(args: UserAgentArgs, opts?: InvokeOptions): Promise<UserAgentResult>
    function userAgentOutput(args: UserAgentOutputArgs, opts?: InvokeOptions): Output<UserAgentResult>
    def user_agent(product_name: Optional[str] = None,
                   product_version: Optional[str] = None,
                   comment: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> UserAgentResult
    def user_agent_output(product_name: pulumi.Input[Optional[str]] = None,
                   product_version: pulumi.Input[Optional[str]] = None,
                   comment: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[UserAgentResult]
    func UserAgent(ctx *Context, args *UserAgentArgs, opts ...InvokeOption) (*UserAgentResult, error)
    func UserAgentOutput(ctx *Context, args *UserAgentOutputArgs, opts ...InvokeOption) UserAgentResultOutput

    > Note: This function is named UserAgent in the Go SDK.

    public static class UserAgent 
    {
        public static Task<UserAgentResult> InvokeAsync(UserAgentArgs args, InvokeOptions? opts = null)
        public static Output<UserAgentResult> Invoke(UserAgentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<UserAgentResult> userAgent(UserAgentArgs args, InvokeOptions options)
    public static Output<UserAgentResult> userAgent(UserAgentArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws:index/userAgent:userAgent
      arguments:
        # arguments dictionary
    data "aws_user_agent" "name" {
        # arguments
    }

    The following arguments are supported:

    Comment string
    Comment describing any additional product details.
    ProductName string
    Product name.
    ProductVersion string
    Product version.
    Comment string
    Comment describing any additional product details.
    ProductName string
    Product name.
    ProductVersion string
    Product version.
    comment string
    Comment describing any additional product details.
    product_name string
    Product name.
    product_version string
    Product version.
    comment String
    Comment describing any additional product details.
    productName String
    Product name.
    productVersion String
    Product version.
    comment string
    Comment describing any additional product details.
    productName string
    Product name.
    productVersion string
    Product version.
    comment str
    Comment describing any additional product details.
    product_name str
    Product name.
    product_version str
    Product version.
    comment String
    Comment describing any additional product details.
    productName String
    Product name.
    productVersion String
    Product version.

    userAgent Result

    The following output properties are available:

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.38.0
    published on Tuesday, Jul 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial