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

harbor.PurgeAuditLog

Explore with Pulumi AI

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

Example Usage

resource "harbor_purge_audit_log" "main" {
  schedule              = "Daily"
  audit_retention_hour  = 24
  include_operations    = "create,pull"
}
Copy

Create PurgeAuditLog Resource

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

Constructor syntax

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

@overload
def PurgeAuditLog(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  audit_retention_hour: Optional[int] = None,
                  include_operations: Optional[str] = None,
                  schedule: Optional[str] = None)
func NewPurgeAuditLog(ctx *Context, name string, args PurgeAuditLogArgs, opts ...ResourceOption) (*PurgeAuditLog, error)
public PurgeAuditLog(string name, PurgeAuditLogArgs args, CustomResourceOptions? opts = null)
public PurgeAuditLog(String name, PurgeAuditLogArgs args)
public PurgeAuditLog(String name, PurgeAuditLogArgs args, CustomResourceOptions options)

type: harbor:PurgeAuditLog
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. PurgeAuditLogArgs
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. PurgeAuditLogArgs
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. PurgeAuditLogArgs
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. PurgeAuditLogArgs
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. PurgeAuditLogArgs
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 purgeAuditLogResource = new Harbor.PurgeAuditLog("purgeAuditLogResource", new()
{
    AuditRetentionHour = 0,
    IncludeOperations = "string",
    Schedule = "string",
});
Copy
example, err := harbor.NewPurgeAuditLog(ctx, "purgeAuditLogResource", &harbor.PurgeAuditLogArgs{
	AuditRetentionHour: pulumi.Int(0),
	IncludeOperations:  pulumi.String("string"),
	Schedule:           pulumi.String("string"),
})
Copy
var purgeAuditLogResource = new PurgeAuditLog("purgeAuditLogResource", PurgeAuditLogArgs.builder()
    .auditRetentionHour(0)
    .includeOperations("string")
    .schedule("string")
    .build());
Copy
purge_audit_log_resource = harbor.PurgeAuditLog("purgeAuditLogResource",
    audit_retention_hour=0,
    include_operations="string",
    schedule="string")
Copy
const purgeAuditLogResource = new harbor.PurgeAuditLog("purgeAuditLogResource", {
    auditRetentionHour: 0,
    includeOperations: "string",
    schedule: "string",
});
Copy
type: harbor:PurgeAuditLog
properties:
    auditRetentionHour: 0
    includeOperations: string
    schedule: string
Copy

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

AuditRetentionHour This property is required. int
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
IncludeOperations This property is required. string
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
AuditRetentionHour This property is required. int
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
IncludeOperations This property is required. string
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
auditRetentionHour This property is required. Integer
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
includeOperations This property is required. String
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
auditRetentionHour This property is required. number
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
includeOperations This property is required. string
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
audit_retention_hour This property is required. int
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
include_operations This property is required. str
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
auditRetentionHour This property is required. Number
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
includeOperations This property is required. String
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"

Outputs

All input properties are implicitly available as output properties. Additionally, the PurgeAuditLog 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 PurgeAuditLog Resource

Get an existing PurgeAuditLog 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?: PurgeAuditLogState, opts?: CustomResourceOptions): PurgeAuditLog
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_retention_hour: Optional[int] = None,
        include_operations: Optional[str] = None,
        schedule: Optional[str] = None) -> PurgeAuditLog
func GetPurgeAuditLog(ctx *Context, name string, id IDInput, state *PurgeAuditLogState, opts ...ResourceOption) (*PurgeAuditLog, error)
public static PurgeAuditLog Get(string name, Input<string> id, PurgeAuditLogState? state, CustomResourceOptions? opts = null)
public static PurgeAuditLog get(String name, Output<String> id, PurgeAuditLogState state, CustomResourceOptions options)
resources:  _:    type: harbor:PurgeAuditLog    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:
AuditRetentionHour int
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
IncludeOperations string
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
AuditRetentionHour int
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
IncludeOperations string
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
auditRetentionHour Integer
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
includeOperations String
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
auditRetentionHour number
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
includeOperations string
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
audit_retention_hour int
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
include_operations str
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"
auditRetentionHour Number
To configure how long audit logs should be kept. For example, if you set this to 24 Harbor will only purge audit logs that are 24 or more hours old.
includeOperations String
Valid values are create delete pull, thoses values can be comma separated. When Create, Delete, or Pull is set, Harbor will include audit logs for those operations in the purge.
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, "5 4 * * *"

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