Class NetlifyDeploymentResource

Namespace

Aspire.Hosting.ApplicationModel

Assembly

IEvangelist.Aspire.Hosting.Netlify.dll

A resource that represents a Netlify site deployer.

[AspireExport(ExposeProperties = true)]
public class NetlifyDeploymentResource : IComputeEnvironmentResource, IResource

Inheritance

object

NetlifyDeploymentResource

Implements

IComputeEnvironmentResource

IResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NetlifyDeploymentResource(string, JavaScriptAppResource, NetlifyDeployOptions, IResourceBuilder<ParameterResource>?)

A resource that represents a Netlify site deployer.

public NetlifyDeploymentResource(string name, JavaScriptAppResource javaScriptAppResource, NetlifyDeployOptions deployOptions, IResourceBuilder<ParameterResource>? authToken = null)

Parameters

name string

The name of the resource.

javaScriptAppResource JavaScriptAppResource

The JavaScript application resource to deploy.

deployOptions NetlifyDeployOptions

The deployment options.

authToken IResourceBuilder<ParameterResource>

An optional parameter resource containing the Netlify authentication token.

Properties

Annotations

Gets the annotations associated with the resource.

[AspireExportIgnore]
public ResourceAnnotationCollection Annotations { get; }

Property Value

ResourceAnnotationCollection

AuthToken

Gets the optional parameter resource containing the Netlify authentication token. When provided, this token is used in place of the interactive netlify login command.

[AspireExportIgnore]
public IResourceBuilder<ParameterResource>? AuthToken { get; }

Property Value

IResourceBuilder<ParameterResource>

BuildDirectory

Gets the directory containing the built static files to deploy.

public string BuildDirectory { get; }

Property Value

string

DeploymentEnvironment

Gets the deployment environment (prod or draft preview).

public string DeploymentEnvironment { get; }

Property Value

string

Name

Gets the name of the resource.

public string Name { get; }

Property Value

string

Options

Gets the deployment options.

public NetlifyDeployOptions Options { get; }

Property Value

NetlifyDeployOptions

SiteName

Gets the optional site name for the Netlify site.

public string? SiteName { get; }

Property Value

string

WorkingDirectory

Gets the working directory of the JavaScript application resource.

public string WorkingDirectory { get; }

Property Value

string