Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Propelauth Provider
  3. API Docs
  4. Image
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

propelauth.Image

Explore with Pulumi AI

propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

Image for PropelAuth hosted pages.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as propelauth from "@pulumi/propelauth";

// Set the logo for your PropelAuth project.
const logoExample = new propelauth.Image("logoExample", {
    imageType: "logo",
    source: `${path.module}/example-logo-image.png`,
    version: "0.1.0",
});
// Set the favicon for your PropelAuth project.
const faviconExample = new propelauth.Image("faviconExample", {
    imageType: "favicon",
    source: `${path.module}/example-favicon-image.png`,
    version: "0.1.0",
});
// And in the case where you've updated the image file at the same source path,
// you can increment the version to force the update in PropelAuth.
const backgroundExample = new propelauth.Image("backgroundExample", {
    imageType: "background",
    source: `${path.module}/example-bg-image.png`,
    version: "0.1.1",
});
Copy
import pulumi
import pulumi_propelauth as propelauth

# Set the logo for your PropelAuth project.
logo_example = propelauth.Image("logoExample",
    image_type="logo",
    source=f"{path['module']}/example-logo-image.png",
    version="0.1.0")
# Set the favicon for your PropelAuth project.
favicon_example = propelauth.Image("faviconExample",
    image_type="favicon",
    source=f"{path['module']}/example-favicon-image.png",
    version="0.1.0")
# And in the case where you've updated the image file at the same source path,
# you can increment the version to force the update in PropelAuth.
background_example = propelauth.Image("backgroundExample",
    image_type="background",
    source=f"{path['module']}/example-bg-image.png",
    version="0.1.1")
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/propelauth/propelauth"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Set the logo for your PropelAuth project.
		_, err := propelauth.NewImage(ctx, "logoExample", &propelauth.ImageArgs{
			ImageType: pulumi.String("logo"),
			Source:    pulumi.Sprintf("%v/example-logo-image.png", path.Module),
			Version:   pulumi.String("0.1.0"),
		})
		if err != nil {
			return err
		}
		// Set the favicon for your PropelAuth project.
		_, err = propelauth.NewImage(ctx, "faviconExample", &propelauth.ImageArgs{
			ImageType: pulumi.String("favicon"),
			Source:    pulumi.Sprintf("%v/example-favicon-image.png", path.Module),
			Version:   pulumi.String("0.1.0"),
		})
		if err != nil {
			return err
		}
		// And in the case where you've updated the image file at the same source path,
		// you can increment the version to force the update in PropelAuth.
		_, err = propelauth.NewImage(ctx, "backgroundExample", &propelauth.ImageArgs{
			ImageType: pulumi.String("background"),
			Source:    pulumi.Sprintf("%v/example-bg-image.png", path.Module),
			Version:   pulumi.String("0.1.1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Propelauth = Pulumi.Propelauth;

return await Deployment.RunAsync(() => 
{
    // Set the logo for your PropelAuth project.
    var logoExample = new Propelauth.Image("logoExample", new()
    {
        ImageType = "logo",
        Source = $"{path.Module}/example-logo-image.png",
        Version = "0.1.0",
    });

    // Set the favicon for your PropelAuth project.
    var faviconExample = new Propelauth.Image("faviconExample", new()
    {
        ImageType = "favicon",
        Source = $"{path.Module}/example-favicon-image.png",
        Version = "0.1.0",
    });

    // And in the case where you've updated the image file at the same source path,
    // you can increment the version to force the update in PropelAuth.
    var backgroundExample = new Propelauth.Image("backgroundExample", new()
    {
        ImageType = "background",
        Source = $"{path.Module}/example-bg-image.png",
        Version = "0.1.1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.propelauth.Image;
import com.pulumi.propelauth.ImageArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        // Set the logo for your PropelAuth project.
        var logoExample = new Image("logoExample", ImageArgs.builder()
            .imageType("logo")
            .source(String.format("%s/example-logo-image.png", path.module()))
            .version("0.1.0")
            .build());

        // Set the favicon for your PropelAuth project.
        var faviconExample = new Image("faviconExample", ImageArgs.builder()
            .imageType("favicon")
            .source(String.format("%s/example-favicon-image.png", path.module()))
            .version("0.1.0")
            .build());

        // And in the case where you've updated the image file at the same source path,
        // you can increment the version to force the update in PropelAuth.
        var backgroundExample = new Image("backgroundExample", ImageArgs.builder()
            .imageType("background")
            .source(String.format("%s/example-bg-image.png", path.module()))
            .version("0.1.1")
            .build());

    }
}
Copy
resources:
  # Set the logo for your PropelAuth project.
  logoExample:
    type: propelauth:Image
    properties:
      imageType: logo
      source: ${path.module}/example-logo-image.png
      version: 0.1.0
  # Set the favicon for your PropelAuth project.
  faviconExample:
    type: propelauth:Image
    properties:
      imageType: favicon
      source: ${path.module}/example-favicon-image.png
      version: 0.1.0
  # And in the case where you've updated the image file at the same source path,
  # // you can increment the version to force the update in PropelAuth.
  backgroundExample:
    type: propelauth:Image
    properties:
      imageType: background
      source: ${path.module}/example-bg-image.png
      version: 0.1.1
Copy

Create Image Resource

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

Constructor syntax

new Image(name: string, args: ImageArgs, opts?: CustomResourceOptions);
@overload
def Image(resource_name: str,
          args: ImageArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Image(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          image_type: Optional[str] = None,
          source: Optional[str] = None,
          version: Optional[str] = None)
func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)
public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)
public Image(String name, ImageArgs args)
public Image(String name, ImageArgs args, CustomResourceOptions options)

type: propelauth:Image
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ImageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ImageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ImageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ImageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ImageArgs
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 imageResource = new Propelauth.Image("imageResource", new()
{
    ImageType = "string",
    Source = "string",
    Version = "string",
});
Copy
example, err := propelauth.NewImage(ctx, "imageResource", &propelauth.ImageArgs{
ImageType: pulumi.String("string"),
Source: pulumi.String("string"),
Version: pulumi.String("string"),
})
Copy
var imageResource = new Image("imageResource", ImageArgs.builder()
    .imageType("string")
    .source("string")
    .version("string")
    .build());
Copy
image_resource = propelauth.Image("imageResource",
    image_type="string",
    source="string",
    version="string")
Copy
const imageResource = new propelauth.Image("imageResource", {
    imageType: "string",
    source: "string",
    version: "string",
});
Copy
type: propelauth:Image
properties:
    imageType: string
    source: string
    version: string
Copy

Image 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 Image resource accepts the following input properties:

ImageType This property is required. string
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
Source This property is required. string
The path to a local file of the image.
Version This property is required. string
The version of the image. This is track updates to the image at the specified source.
ImageType This property is required. string
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
Source This property is required. string
The path to a local file of the image.
Version This property is required. string
The version of the image. This is track updates to the image at the specified source.
imageType This property is required. String
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
source This property is required. String
The path to a local file of the image.
version This property is required. String
The version of the image. This is track updates to the image at the specified source.
imageType This property is required. string
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
source This property is required. string
The path to a local file of the image.
version This property is required. string
The version of the image. This is track updates to the image at the specified source.
image_type This property is required. str
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
source This property is required. str
The path to a local file of the image.
version This property is required. str
The version of the image. This is track updates to the image at the specified source.
imageType This property is required. String
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
source This property is required. String
The path to a local file of the image.
version This property is required. String
The version of the image. This is track updates to the image at the specified source.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ImageId string
The unique identifier of the image. This is generated by PropelAuth.
ImageUrl string
The URL of the image. This is generated by PropelAuth.
Id string
The provider-assigned unique ID for this managed resource.
ImageId string
The unique identifier of the image. This is generated by PropelAuth.
ImageUrl string
The URL of the image. This is generated by PropelAuth.
id String
The provider-assigned unique ID for this managed resource.
imageId String
The unique identifier of the image. This is generated by PropelAuth.
imageUrl String
The URL of the image. This is generated by PropelAuth.
id string
The provider-assigned unique ID for this managed resource.
imageId string
The unique identifier of the image. This is generated by PropelAuth.
imageUrl string
The URL of the image. This is generated by PropelAuth.
id str
The provider-assigned unique ID for this managed resource.
image_id str
The unique identifier of the image. This is generated by PropelAuth.
image_url str
The URL of the image. This is generated by PropelAuth.
id String
The provider-assigned unique ID for this managed resource.
imageId String
The unique identifier of the image. This is generated by PropelAuth.
imageUrl String
The URL of the image. This is generated by PropelAuth.

Look up Existing Image Resource

Get an existing Image 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?: ImageState, opts?: CustomResourceOptions): Image
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        image_id: Optional[str] = None,
        image_type: Optional[str] = None,
        image_url: Optional[str] = None,
        source: Optional[str] = None,
        version: Optional[str] = None) -> Image
func GetImage(ctx *Context, name string, id IDInput, state *ImageState, opts ...ResourceOption) (*Image, error)
public static Image Get(string name, Input<string> id, ImageState? state, CustomResourceOptions? opts = null)
public static Image get(String name, Output<String> id, ImageState state, CustomResourceOptions options)
resources:  _:    type: propelauth:Image    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ImageId string
The unique identifier of the image. This is generated by PropelAuth.
ImageType string
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
ImageUrl string
The URL of the image. This is generated by PropelAuth.
Source string
The path to a local file of the image.
Version string
The version of the image. This is track updates to the image at the specified source.
ImageId string
The unique identifier of the image. This is generated by PropelAuth.
ImageType string
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
ImageUrl string
The URL of the image. This is generated by PropelAuth.
Source string
The path to a local file of the image.
Version string
The version of the image. This is track updates to the image at the specified source.
imageId String
The unique identifier of the image. This is generated by PropelAuth.
imageType String
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
imageUrl String
The URL of the image. This is generated by PropelAuth.
source String
The path to a local file of the image.
version String
The version of the image. This is track updates to the image at the specified source.
imageId string
The unique identifier of the image. This is generated by PropelAuth.
imageType string
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
imageUrl string
The URL of the image. This is generated by PropelAuth.
source string
The path to a local file of the image.
version string
The version of the image. This is track updates to the image at the specified source.
image_id str
The unique identifier of the image. This is generated by PropelAuth.
image_type str
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
image_url str
The URL of the image. This is generated by PropelAuth.
source str
The path to a local file of the image.
version str
The version of the image. This is track updates to the image at the specified source.
imageId String
The unique identifier of the image. This is generated by PropelAuth.
imageType String
The type of the image. This is used to determine where the image is used in PropelAuth. Accepted values are logo, favicon, and background.
imageUrl String
The URL of the image. This is generated by PropelAuth.
source String
The path to a local file of the image.
version String
The version of the image. This is track updates to the image at the specified source.

Import

Import using the image_type as the ID: logo, favicon, or background.

$ pulumi import propelauth:index/image:Image logo_example logo
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
propelauth propelauth/terraform-provider-propelauth
License
Notes
This Pulumi package is based on the propelauth Terraform Provider.
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth