RegistryScanningConfiguration class

Provides an Elastic Container Registry Scanning Configuration. Can't be completely deleted, instead reverts to the default BASIC scanning configuration without rules.

Example Usage

Basic example

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

const configuration = new aws.ecr.RegistryScanningConfiguration("configuration", {
    rules: [{
        repositoryFilters: [{
            filter: "example",
            filterType: "WILDCARD",
        }],
        scanFrequency: "CONTINUOUS_SCAN",
    }],
    scanType: "ENHANCED",
});
import pulumi
import pulumi_aws as aws

configuration = aws.ecr.RegistryScanningConfiguration("configuration",
    rules=[{
        "repository_filters": [{
            "filter": "example",
            "filter_type": "WILDCARD",
        }],
        "scan_frequency": "CONTINUOUS_SCAN",
    }],
    scan_type="ENHANCED")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var configuration = new Aws.Ecr.RegistryScanningConfiguration("configuration", new()
    {
        Rules = new[]
        {
            new Aws.Ecr.Inputs.RegistryScanningConfigurationRuleArgs
            {
                RepositoryFilters = new[]
                {
                    new Aws.Ecr.Inputs.RegistryScanningConfigurationRuleRepositoryFilterArgs
                    {
                        Filter = "example",
                        FilterType = "WILDCARD",
                    },
                },
                ScanFrequency = "CONTINUOUS_SCAN",
            },
        },
        ScanType = "ENHANCED",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ecr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ecr.NewRegistryScanningConfiguration(ctx, "configuration", &ecr.RegistryScanningConfigurationArgs{
			Rules: ecr.RegistryScanningConfigurationRuleArray{
				&ecr.RegistryScanningConfigurationRuleArgs{
					RepositoryFilters: ecr.RegistryScanningConfigurationRuleRepositoryFilterArray{
						&ecr.RegistryScanningConfigurationRuleRepositoryFilterArgs{
							Filter:     pulumi.String("example"),
							FilterType: pulumi.String("WILDCARD"),
						},
					},
					ScanFrequency: pulumi.String("CONTINUOUS_SCAN"),
				},
			},
			ScanType: pulumi.String("ENHANCED"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ecr_registryscanningconfiguration" "configuration" {
  rules {
    repository_filters {
      filter      = "example"
      filter_type = "WILDCARD"
    }
    scan_frequency = "CONTINUOUS_SCAN"
  }
  scan_type = "ENHANCED"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecr.RegistryScanningConfiguration;
import com.pulumi.aws.ecr.RegistryScanningConfigurationArgs;
import com.pulumi.aws.ecr.inputs.RegistryScanningConfigurationRuleArgs;
import com.pulumi.aws.ecr.inputs.RegistryScanningConfigurationRuleRepositoryFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var configuration = new RegistryScanningConfiguration("configuration", RegistryScanningConfigurationArgs.builder()
            .rules(RegistryScanningConfigurationRuleArgs.builder()
                .repositoryFilters(RegistryScanningConfigurationRuleRepositoryFilterArgs.builder()
                    .filter("example")
                    .filterType("WILDCARD")
                    .build())
                .scanFrequency("CONTINUOUS_SCAN")
                .build())
            .scanType("ENHANCED")
            .build());

    }
}
resources:
  configuration:
    type: aws:ecr:RegistryScanningConfiguration
    properties:
      rules:
        - repositoryFilters:
            - filter: example
              filterType: WILDCARD
          scanFrequency: CONTINUOUS_SCAN
      scanType: ENHANCED

Multiple rules

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

const test = new aws.ecr.RegistryScanningConfiguration("test", {
    rules: [
        {
            repositoryFilters: [{
                filter: "*",
                filterType: "WILDCARD",
            }],
            scanFrequency: "SCAN_ON_PUSH",
        },
        {
            repositoryFilters: [{
                filter: "example",
                filterType: "WILDCARD",
            }],
            scanFrequency: "CONTINUOUS_SCAN",
        },
    ],
    scanType: "ENHANCED",
});
import pulumi
import pulumi_aws as aws

test = aws.ecr.RegistryScanningConfiguration("test",
    rules=[
        {
            "repository_filters": [{
                "filter": "*",
                "filter_type": "WILDCARD",
            }],
            "scan_frequency": "SCAN_ON_PUSH",
        },
        {
            "repository_filters": [{
                "filter": "example",
                "filter_type": "WILDCARD",
            }],
            "scan_frequency": "CONTINUOUS_SCAN",
        },
    ],
    scan_type="ENHANCED")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Ecr.RegistryScanningConfiguration("test", new()
    {
        Rules = new[]
        {
            new Aws.Ecr.Inputs.RegistryScanningConfigurationRuleArgs
            {
                RepositoryFilters = new[]
                {
                    new Aws.Ecr.Inputs.RegistryScanningConfigurationRuleRepositoryFilterArgs
                    {
                        Filter = "*",
                        FilterType = "WILDCARD",
                    },
                },
                ScanFrequency = "SCAN_ON_PUSH",
            },
            new Aws.Ecr.Inputs.RegistryScanningConfigurationRuleArgs
            {
                RepositoryFilters = new[]
                {
                    new Aws.Ecr.Inputs.RegistryScanningConfigurationRuleRepositoryFilterArgs
                    {
                        Filter = "example",
                        FilterType = "WILDCARD",
                    },
                },
                ScanFrequency = "CONTINUOUS_SCAN",
            },
        },
        ScanType = "ENHANCED",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ecr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ecr.NewRegistryScanningConfiguration(ctx, "test", &ecr.RegistryScanningConfigurationArgs{
			Rules: ecr.RegistryScanningConfigurationRuleArray{
				&ecr.RegistryScanningConfigurationRuleArgs{
					RepositoryFilters: ecr.RegistryScanningConfigurationRuleRepositoryFilterArray{
						&ecr.RegistryScanningConfigurationRuleRepositoryFilterArgs{
							Filter:     pulumi.String("*"),
							FilterType: pulumi.String("WILDCARD"),
						},
					},
					ScanFrequency: pulumi.String("SCAN_ON_PUSH"),
				},
				&ecr.RegistryScanningConfigurationRuleArgs{
					RepositoryFilters: ecr.RegistryScanningConfigurationRuleRepositoryFilterArray{
						&ecr.RegistryScanningConfigurationRuleRepositoryFilterArgs{
							Filter:     pulumi.String("example"),
							FilterType: pulumi.String("WILDCARD"),
						},
					},
					ScanFrequency: pulumi.String("CONTINUOUS_SCAN"),
				},
			},
			ScanType: pulumi.String("ENHANCED"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ecr_registryscanningconfiguration" "test" {
  rules {
    repository_filters {
      filter      = "*"
      filter_type = "WILDCARD"
    }
    scan_frequency = "SCAN_ON_PUSH"
  }
  rules {
    repository_filters {
      filter      = "example"
      filter_type = "WILDCARD"
    }
    scan_frequency = "CONTINUOUS_SCAN"
  }
  scan_type = "ENHANCED"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecr.RegistryScanningConfiguration;
import com.pulumi.aws.ecr.RegistryScanningConfigurationArgs;
import com.pulumi.aws.ecr.inputs.RegistryScanningConfigurationRuleArgs;
import com.pulumi.aws.ecr.inputs.RegistryScanningConfigurationRuleRepositoryFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var test = new RegistryScanningConfiguration("test", RegistryScanningConfigurationArgs.builder()
            .rules(
                RegistryScanningConfigurationRuleArgs.builder()
                    .repositoryFilters(RegistryScanningConfigurationRuleRepositoryFilterArgs.builder()
                        .filter("*")
                        .filterType("WILDCARD")
                        .build())
                    .scanFrequency("SCAN_ON_PUSH")
                    .build(),
                RegistryScanningConfigurationRuleArgs.builder()
                    .repositoryFilters(RegistryScanningConfigurationRuleRepositoryFilterArgs.builder()
                        .filter("example")
                        .filterType("WILDCARD")
                        .build())
                    .scanFrequency("CONTINUOUS_SCAN")
                    .build())
            .scanType("ENHANCED")
            .build());

    }
}
resources:
  test:
    type: aws:ecr:RegistryScanningConfiguration
    properties:
      rules:
        - repositoryFilters:
            - filter: '*'
              filterType: WILDCARD
          scanFrequency: SCAN_ON_PUSH
        - repositoryFilters:
            - filter: example
              filterType: WILDCARD
          scanFrequency: CONTINUOUS_SCAN
      scanType: ENHANCED

Import

Using pulumi import, import ECR Scanning Configurations using the registryId. For example:

$ pulumi import aws:ecr/registryScanningConfiguration:RegistryScanningConfiguration example 123456789012

Constructors

RegistryScanningConfiguration(String name, {RegistryScanningConfigurationArgs? args, CustomResourceOptions? options})
Creates a new RegistryScanningConfiguration. name The Pulumi resource name. args Arguments used to configure this RegistryScanningConfiguration. The set of arguments for RegistryScanningConfiguration. options Resource options controlling this resource's behavior.
RegistryScanningConfiguration.reference(String urn)
Creates a typed reference to an existing RegistryScanningConfiguration resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
registryId ↔ Output<String>
The registry ID the scanning configuration applies to.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
rules ↔ Output<List<RegistryScanningConfigurationRule>?>
One or multiple blocks specifying scanning rules to determine which repository filters are used and at what frequency scanning will occur. See below for schema.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scanType ↔ Output<String>
the scanning type to set for the registry. Can be either ENHANCED or BASIC.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RegistryScanningConfigurationState? state, CustomResourceOptions? options}) → RegistryScanningConfiguration
Gets an existing RegistryScanningConfiguration resource's state with the given name and id.