This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

inspector¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.inspector.AssessmentTarget(resource_name, opts=None, name=None, resource_group_arn=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Inspector assessment target

import pulumi
import pulumi_aws as aws

bar = aws.inspector.ResourceGroup("bar", tags={
    "Env": "bar",
    "Name": "foo",
})
foo = aws.inspector.AssessmentTarget("foo", resource_group_arn=bar.arn)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the assessment target.
resource_group_arn (pulumi.Input[str]) – Inspector Resource Group Amazon Resource Name (ARN) stating tags for instance matching. If not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

arn: pulumi.Output[str] = None¶: The target assessment ARN.

name: pulumi.Output[str] = None¶: The name of the assessment target.

resource_group_arn: pulumi.Output[str] = None¶: Inspector Resource Group Amazon Resource Name (ARN) stating tags for instance matching. If not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

static get(resource_name, id, opts=None, arn=None, name=None, resource_group_arn=None)¶

Get an existing AssessmentTarget resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The target assessment ARN.
name (pulumi.Input[str]) – The name of the assessment target.
resource_group_arn (pulumi.Input[str]) – Inspector Resource Group Amazon Resource Name (ARN) stating tags for instance matching. If not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.inspector.AssessmentTemplate(resource_name, opts=None, duration=None, name=None, rules_package_arns=None, tags=None, target_arn=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Inspector assessment template

import pulumi
import pulumi_aws as aws

example = aws.inspector.AssessmentTemplate("example",
    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",
    ],
    target_arn=aws_inspector_assessment_target["example"]["arn"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
duration (pulumi.Input[float]) – The duration of the inspector run.
name (pulumi.Input[str]) – The name of the assessment template.
rules_package_arns (pulumi.Input[list]) – The rules to be used during the run.
tags (pulumi.Input[dict]) – Key-value map of tags for the Inspector assessment template.
target_arn (pulumi.Input[str]) – The assessment target ARN to attach the template to.

arn: pulumi.Output[str] = None¶: The template assessment ARN.

duration: pulumi.Output[float] = None¶: The duration of the inspector run.

name: pulumi.Output[str] = None¶: The name of the assessment template.

rules_package_arns: pulumi.Output[list] = None¶: The rules to be used during the run.

tags: pulumi.Output[dict] = None¶: Key-value map of tags for the Inspector assessment template.

target_arn: pulumi.Output[str] = None¶: The assessment target ARN to attach the template to.

static get(resource_name, id, opts=None, arn=None, duration=None, name=None, rules_package_arns=None, tags=None, target_arn=None)¶

Get an existing AssessmentTemplate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The template assessment ARN.
duration (pulumi.Input[float]) – The duration of the inspector run.
name (pulumi.Input[str]) – The name of the assessment template.
rules_package_arns (pulumi.Input[list]) – The rules to be used during the run.
tags (pulumi.Input[dict]) – Key-value map of tags for the Inspector assessment template.
target_arn (pulumi.Input[str]) – The assessment target ARN to attach the template to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.inspector.AwaitableGetRulesPackagesResult(arns=None, id=None)¶

class pulumi_aws.inspector.GetRulesPackagesResult(arns=None, id=None)¶

A collection of values returned by getRulesPackages.

arns = None¶: A list of the AWS Inspector Rules Packages arns available in the AWS region.

id = None¶: The provider-assigned unique ID for this managed resource.

class pulumi_aws.inspector.ResourceGroup(resource_name, opts=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides an Amazon Inspector resource group resource.

import pulumi
import pulumi_aws as aws

example = aws.inspector.ResourceGroup("example", tags={
    "Env": "bar",
    "Name": "foo",
})

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
tags (pulumi.Input[dict]) – Key-value map of tags that are used to select the EC2 instances to be included in an Amazon Inspector assessment target resource.

arn: pulumi.Output[str] = None¶: The resource group ARN.

tags: pulumi.Output[dict] = None¶: Key-value map of tags that are used to select the EC2 instances to be included in an Amazon Inspector assessment target resource.

static get(resource_name, id, opts=None, arn=None, tags=None)¶

Get an existing ResourceGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The resource group ARN.
tags (pulumi.Input[dict]) – Key-value map of tags that are used to select the EC2 instances to be included in an Amazon Inspector assessment target resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_aws.inspector.get_rules_packages(opts=None)¶

The AWS Inspector Rules Packages data source allows access to the list of AWS Inspector Rules Packages which can be used by AWS Inspector within the region configured in the provider.

import pulumi
import pulumi_aws as aws

rules = aws.inspector.get_rules_packages()
# e.g. Use in aws_inspector_assessment_template
group = aws.inspector.ResourceGroup("group", tags={
    "test": "test",
})
assessment_assessment_target = aws.inspector.AssessmentTarget("assessmentAssessmentTarget", resource_group_arn=group.arn)
assessment_assessment_template = aws.inspector.AssessmentTemplate("assessmentAssessmentTemplate",
    duration="60",
    rules_package_arns=rules.arns,
    target_arn=assessment_assessment_target.arn)

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

inspector¶

On This Page