1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. FileLink
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

    To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLinks contain a URL that you can use to retrieve the contents of the file without authentication.

    Create FileLink Resource

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

    Constructor syntax

    new FileLink(name: string, args: FileLinkArgs, opts?: CustomResourceOptions);
    @overload
    def FileLink(resource_name: str,
                 args: FileLinkArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def FileLink(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 file: Optional[str] = None,
                 expires_at: Optional[float] = None,
                 metadata: Optional[Mapping[str, str]] = None)
    func NewFileLink(ctx *Context, name string, args FileLinkArgs, opts ...ResourceOption) (*FileLink, error)
    public FileLink(string name, FileLinkArgs args, CustomResourceOptions? opts = null)
    public FileLink(String name, FileLinkArgs args)
    public FileLink(String name, FileLinkArgs args, CustomResourceOptions options)
    
    type: stripe:FileLink
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "stripe_file_link" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args FileLinkArgs
    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 FileLinkArgs
    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 FileLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileLinkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var fileLinkResource = new Stripe.FileLink("fileLinkResource", new()
    {
        File = "string",
        ExpiresAt = 0.0,
        Metadata = 
        {
            { "string", "string" },
        },
    });
    
    example, err := stripe.NewFileLink(ctx, "fileLinkResource", &stripe.FileLinkArgs{
    	File:      pulumi.String("string"),
    	ExpiresAt: pulumi.Float64(0),
    	Metadata: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    resource "stripe_file_link" "fileLinkResource" {
      lifecycle {
        create_before_destroy = true
      }
      file       = "string"
      expires_at = 0
      metadata = {
        "string" = "string"
      }
    }
    
    var fileLinkResource = new FileLink("fileLinkResource", FileLinkArgs.builder()
        .file("string")
        .expiresAt(0.0)
        .metadata(Map.of("string", "string"))
        .build());
    
    file_link_resource = stripe.FileLink("fileLinkResource",
        file="string",
        expires_at=float(0),
        metadata={
            "string": "string",
        })
    
    const fileLinkResource = new stripe.FileLink("fileLinkResource", {
        file: "string",
        expiresAt: 0,
        metadata: {
            string: "string",
        },
    });
    
    type: stripe:FileLink
    properties:
        expiresAt: 0
        file: string
        metadata:
            string: string
    

    FileLink Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FileLink resource accepts the following input properties:

    File string
    The file object this link points to.
    ExpiresAt double
    Time that the link expires.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    File string
    The file object this link points to.
    ExpiresAt float64
    Time that the link expires.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    file string
    The file object this link points to.
    expires_at number
    Time that the link expires.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    file String
    The file object this link points to.
    expiresAt Double
    Time that the link expires.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    file string
    The file object this link points to.
    expiresAt number
    Time that the link expires.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    file str
    The file object this link points to.
    expires_at float
    Time that the link expires.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    file String
    The file object this link points to.
    expiresAt Number
    Time that the link expires.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    Outputs

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

    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Expired bool
    Returns if the link is already expired.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Url string
    The publicly accessible URL to download the file.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Expired bool
    Returns if the link is already expired.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Url string
    The publicly accessible URL to download the file.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired bool
    Returns if the link is already expired.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    url string
    The publicly accessible URL to download the file.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired Boolean
    Returns if the link is already expired.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    url String
    The publicly accessible URL to download the file.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired boolean
    Returns if the link is already expired.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    url string
    The publicly accessible URL to download the file.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired bool
    Returns if the link is already expired.
    id str
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object str
    String representing the object's type. Objects of the same type share the same value.
    url str
    The publicly accessible URL to download the file.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired Boolean
    Returns if the link is already expired.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    url String
    The publicly accessible URL to download the file.

    Look up Existing FileLink Resource

    Get an existing FileLink resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FileLinkState, opts?: CustomResourceOptions): FileLink
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created: Optional[float] = None,
            expired: Optional[bool] = None,
            expires_at: Optional[float] = None,
            file: Optional[str] = None,
            livemode: Optional[bool] = None,
            metadata: Optional[Mapping[str, str]] = None,
            object: Optional[str] = None,
            url: Optional[str] = None) -> FileLink
    func GetFileLink(ctx *Context, name string, id IDInput, state *FileLinkState, opts ...ResourceOption) (*FileLink, error)
    public static FileLink Get(string name, Input<string> id, FileLinkState? state, CustomResourceOptions? opts = null)
    public static FileLink get(String name, Output<String> id, FileLinkState state, CustomResourceOptions options)
    resources:  _:    type: stripe:FileLink    get:      id: ${id}
    import {
      to = stripe_file_link.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Expired bool
    Returns if the link is already expired.
    ExpiresAt double
    Time that the link expires.
    File string
    The file object this link points to.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Url string
    The publicly accessible URL to download the file.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Expired bool
    Returns if the link is already expired.
    ExpiresAt float64
    Time that the link expires.
    File string
    The file object this link points to.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Url string
    The publicly accessible URL to download the file.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired bool
    Returns if the link is already expired.
    expires_at number
    Time that the link expires.
    file string
    The file object this link points to.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object string
    String representing the object's type. Objects of the same type share the same value.
    url string
    The publicly accessible URL to download the file.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired Boolean
    Returns if the link is already expired.
    expiresAt Double
    Time that the link expires.
    file String
    The file object this link points to.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object String
    String representing the object's type. Objects of the same type share the same value.
    url String
    The publicly accessible URL to download the file.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired boolean
    Returns if the link is already expired.
    expiresAt number
    Time that the link expires.
    file string
    The file object this link points to.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object string
    String representing the object's type. Objects of the same type share the same value.
    url string
    The publicly accessible URL to download the file.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired bool
    Returns if the link is already expired.
    expires_at float
    Time that the link expires.
    file str
    The file object this link points to.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object str
    String representing the object's type. Objects of the same type share the same value.
    url str
    The publicly accessible URL to download the file.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    expired Boolean
    Returns if the link is already expired.
    expiresAt Number
    Time that the link expires.
    file String
    The file object this link points to.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object String
    String representing the object's type. Objects of the same type share the same value.
    url String
    The publicly accessible URL to download the file.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial