Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harbor
  3. API Docs
  4. GarbageCollection
Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor

harbor.GarbageCollection

Explore with Pulumi AI

Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor

Example Usage

resource "harbor_garbage_collection" "main" {
  schedule        = "Daily"
  delete_untagged = true
  workers         = 1
}
Copy

Create GarbageCollection Resource

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

Constructor syntax

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

@overload
def GarbageCollection(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      schedule: Optional[str] = None,
                      delete_untagged: Optional[bool] = None,
                      workers: Optional[int] = None)
func NewGarbageCollection(ctx *Context, name string, args GarbageCollectionArgs, opts ...ResourceOption) (*GarbageCollection, error)
public GarbageCollection(string name, GarbageCollectionArgs args, CustomResourceOptions? opts = null)
public GarbageCollection(String name, GarbageCollectionArgs args)
public GarbageCollection(String name, GarbageCollectionArgs args, CustomResourceOptions options)

type: harbor:GarbageCollection
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. GarbageCollectionArgs
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. GarbageCollectionArgs
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. GarbageCollectionArgs
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. GarbageCollectionArgs
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. GarbageCollectionArgs
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 garbageCollectionResource = new Harbor.GarbageCollection("garbageCollectionResource", new()
{
    Schedule = "string",
    DeleteUntagged = false,
    Workers = 0,
});
Copy
example, err := harbor.NewGarbageCollection(ctx, "garbageCollectionResource", &harbor.GarbageCollectionArgs{
	Schedule:       pulumi.String("string"),
	DeleteUntagged: pulumi.Bool(false),
	Workers:        pulumi.Int(0),
})
Copy
var garbageCollectionResource = new GarbageCollection("garbageCollectionResource", GarbageCollectionArgs.builder()
    .schedule("string")
    .deleteUntagged(false)
    .workers(0)
    .build());
Copy
garbage_collection_resource = harbor.GarbageCollection("garbageCollectionResource",
    schedule="string",
    delete_untagged=False,
    workers=0)
Copy
const garbageCollectionResource = new harbor.GarbageCollection("garbageCollectionResource", {
    schedule: "string",
    deleteUntagged: false,
    workers: 0,
});
Copy
type: harbor:GarbageCollection
properties:
    deleteUntagged: false
    schedule: string
    workers: 0
Copy

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

Schedule This property is required. string
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
DeleteUntagged bool
Allow garbage collection on untagged artifacts.
Workers int
Number of workers to run the garbage collection, value must be between 1 and 5.
Schedule This property is required. string
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
DeleteUntagged bool
Allow garbage collection on untagged artifacts.
Workers int
Number of workers to run the garbage collection, value must be between 1 and 5.
schedule This property is required. String
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
deleteUntagged Boolean
Allow garbage collection on untagged artifacts.
workers Integer
Number of workers to run the garbage collection, value must be between 1 and 5.
schedule This property is required. string
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
deleteUntagged boolean
Allow garbage collection on untagged artifacts.
workers number
Number of workers to run the garbage collection, value must be between 1 and 5.
schedule This property is required. str
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
delete_untagged bool
Allow garbage collection on untagged artifacts.
workers int
Number of workers to run the garbage collection, value must be between 1 and 5.
schedule This property is required. String
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
deleteUntagged Boolean
Allow garbage collection on untagged artifacts.
workers Number
Number of workers to run the garbage collection, value must be between 1 and 5.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GarbageCollection Resource

Get an existing GarbageCollection 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?: GarbageCollectionState, opts?: CustomResourceOptions): GarbageCollection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delete_untagged: Optional[bool] = None,
        schedule: Optional[str] = None,
        workers: Optional[int] = None) -> GarbageCollection
func GetGarbageCollection(ctx *Context, name string, id IDInput, state *GarbageCollectionState, opts ...ResourceOption) (*GarbageCollection, error)
public static GarbageCollection Get(string name, Input<string> id, GarbageCollectionState? state, CustomResourceOptions? opts = null)
public static GarbageCollection get(String name, Output<String> id, GarbageCollectionState state, CustomResourceOptions options)
resources:  _:    type: harbor:GarbageCollection    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:
DeleteUntagged bool
Allow garbage collection on untagged artifacts.
Schedule string
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
Workers int
Number of workers to run the garbage collection, value must be between 1 and 5.
DeleteUntagged bool
Allow garbage collection on untagged artifacts.
Schedule string
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
Workers int
Number of workers to run the garbage collection, value must be between 1 and 5.
deleteUntagged Boolean
Allow garbage collection on untagged artifacts.
schedule String
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
workers Integer
Number of workers to run the garbage collection, value must be between 1 and 5.
deleteUntagged boolean
Allow garbage collection on untagged artifacts.
schedule string
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
workers number
Number of workers to run the garbage collection, value must be between 1 and 5.
delete_untagged bool
Allow garbage collection on untagged artifacts.
schedule str
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
workers int
Number of workers to run the garbage collection, value must be between 1 and 5.
deleteUntagged Boolean
Allow garbage collection on untagged artifacts.
schedule String
Sets the schedule how often the Garbage Collection will run. Can be to "hourly", "daily", "weekly" or can be a custom cron string ie, "0 5 4 * * *"
workers Number
Number of workers to run the garbage collection, value must be between 1 and 5.

Package Details

Repository
harbor pulumiverse/pulumi-harbor
License
Apache-2.0
Notes
This Pulumi package is based on the harbor Terraform Provider.
Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor