AssessmentTemplate class
Provides an Inspector Classic Assessment Template
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.inspector.AssessmentTemplate("example", {
eventSubscriptions: [{
event: "ASSESSMENT_RUN_COMPLETED",
topicArn: exampleAwsSnsTopic.arn,
}],
name: "example",
targetArn: exampleAwsInspectorAssessmentTarget.arn,
duration: 3600,
rulesPackageArns: [
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD",
],
});
import pulumi
import pulumi_aws as aws
example = aws.inspector.AssessmentTemplate("example",
event_subscriptions=[{
"event": "ASSESSMENT_RUN_COMPLETED",
"topic_arn": example_aws_sns_topic["arn"],
}],
name="example",
target_arn=example_aws_inspector_assessment_target["arn"],
duration=3600,
rules_package_arns=[
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD",
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Inspector.AssessmentTemplate("example", new()
{
EventSubscriptions = new[]
{
new Aws.Inspector.Inputs.AssessmentTemplateEventSubscriptionArgs
{
Event = "ASSESSMENT_RUN_COMPLETED",
TopicArn = exampleAwsSnsTopic.Arn,
},
},
Name = "example",
TargetArn = exampleAwsInspectorAssessmentTarget.Arn,
Duration = 3600,
RulesPackageArns = new[]
{
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/inspector"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := inspector.NewAssessmentTemplate(ctx, "example", &inspector.AssessmentTemplateArgs{
EventSubscriptions: inspector.AssessmentTemplateEventSubscriptionArray{
&inspector.AssessmentTemplateEventSubscriptionArgs{
Event: pulumi.String("ASSESSMENT_RUN_COMPLETED"),
TopicArn: pulumi.Any(exampleAwsSnsTopic.Arn),
},
},
Name: pulumi.String("example"),
TargetArn: pulumi.Any(exampleAwsInspectorAssessmentTarget.Arn),
Duration: pulumi.Int(3600),
RulesPackageArns: pulumi.StringArray{
pulumi.String("arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p"),
pulumi.String("arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc"),
pulumi.String("arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ"),
pulumi.String("arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_inspector_assessmenttemplate" "example" {
event_subscriptions {
event = "ASSESSMENT_RUN_COMPLETED"
topic_arn = exampleAwsSnsTopic.arn
}
name = "example"
target_arn = exampleAwsInspectorAssessmentTarget.arn
duration = 3600
rules_package_arns = ["arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p", "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc", "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.inspector.AssessmentTemplate;
import com.pulumi.aws.inspector.AssessmentTemplateArgs;
import com.pulumi.aws.inspector.inputs.AssessmentTemplateEventSubscriptionArgs;
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 example = new AssessmentTemplate("example", AssessmentTemplateArgs.builder()
.eventSubscriptions(AssessmentTemplateEventSubscriptionArgs.builder()
.event("ASSESSMENT_RUN_COMPLETED")
.topicArn(exampleAwsSnsTopic.arn())
.build())
.name("example")
.targetArn(exampleAwsInspectorAssessmentTarget.arn())
.duration(3600)
.rulesPackageArns(
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ",
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD")
.build());
}
}
resources:
example:
type: aws:inspector:AssessmentTemplate
properties:
eventSubscriptions:
- event: ASSESSMENT_RUN_COMPLETED
topicArn: ${exampleAwsSnsTopic.arn}
name: example
targetArn: ${exampleAwsInspectorAssessmentTarget.arn}
duration: 3600
rulesPackageArns:
- arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p
- arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc
- arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ
- arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD
Import
Identity Schema
Required
arn(String) ARN of the Inspector assessment template.
Using pulumi import, import aws.inspector.AssessmentTemplate using the template assessment ARN. For example:
$ pulumi import aws:inspector/assessmentTemplate:AssessmentTemplate example arn:aws:inspector:us-west-2:123456789012:target/0-9IaAzhGR/template/0-WEcjR8CH
Constructors
- AssessmentTemplate(String name, {AssessmentTemplateArgs? args, CustomResourceOptions? options})
-
Creates a new AssessmentTemplate.
nameThe Pulumi resource name.argsArguments used to configure this AssessmentTemplate. The set of arguments for AssessmentTemplate.optionsResource options controlling this resource's behavior. - AssessmentTemplate.reference(String urn)
- Creates a typed reference to an existing AssessmentTemplate resource.
Properties
-
arn
↔ Output<
String> -
The template assessment ARN.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
duration
↔ Output<
int> -
The duration of the inspector run.
latefinal
-
eventSubscriptions
↔ Output<
List< AssessmentTemplateEventSubscription> ?> -
A block that enables sending notifications about a specified assessment template event to a designated SNS topic. See Event Subscriptions for details.
latefinal
- 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
-
name
↔ Output<
String> -
The name of the assessment template.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
rulesPackageArns
↔ Output<
List< String> > -
The rules to be used during the run.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of tags for the Inspector assessment template. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
targetArn
↔ Output<
String> -
The assessment target ARN to attach the template to.
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, {AssessmentTemplateState? state, CustomResourceOptions? options}) → AssessmentTemplate -
Gets an existing AssessmentTemplate resource's state with the given
nameandid.