com.pulumi.aws.auditmanager.kotlin.Assessment.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.auditmanager.kotlin
import com.pulumi.aws.auditmanager.kotlin.outputs.AssessmentAssessmentReportsDestination
import com.pulumi.aws.auditmanager.kotlin.outputs.AssessmentRole
import com.pulumi.aws.auditmanager.kotlin.outputs.AssessmentRolesAll
import com.pulumi.aws.auditmanager.kotlin.outputs.AssessmentScope
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.aws.auditmanager.kotlin.outputs.AssessmentAssessmentReportsDestination.Companion.toKotlin as assessmentAssessmentReportsDestinationToKotlin
import com.pulumi.aws.auditmanager.kotlin.outputs.AssessmentRole.Companion.toKotlin as assessmentRoleToKotlin
import com.pulumi.aws.auditmanager.kotlin.outputs.AssessmentRolesAll.Companion.toKotlin as assessmentRolesAllToKotlin
import com.pulumi.aws.auditmanager.kotlin.outputs.AssessmentScope.Companion.toKotlin as assessmentScopeToKotlin
/**
* Builder for [Assessment].
*/
@PulumiTagMarker
public class AssessmentResourceBuilder internal constructor() {
public var name: String? = null
public var args: AssessmentArgs = AssessmentArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend AssessmentArgsBuilder.() -> Unit) {
val builder = AssessmentArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Assessment {
val builtJavaResource = com.pulumi.aws.auditmanager.Assessment(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Assessment(builtJavaResource)
}
}
/**
* Resource for managing an AWS Audit Manager Assessment.
* ## Example Usage
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const test = new aws.auditmanager.Assessment("test", {
* name: "example",
* assessmentReportsDestination: {
* destination: `s3://${testAwsS3Bucket.id}`,
* destinationType: "S3",
* },
* frameworkId: testAwsAuditmanagerFramework.id,
* roles: [{
* roleArn: testAwsIamRole.arn,
* roleType: "PROCESS_OWNER",
* }],
* scope: {
* awsAccounts: [{
* id: current.accountId,
* }],
* awsServices: [{
* serviceName: "S3",
* }],
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* test = aws.auditmanager.Assessment("test",
* name="example",
* assessment_reports_destination={
* "destination": f"s3://{test_aws_s3_bucket['id']}",
* "destination_type": "S3",
* },
* framework_id=test_aws_auditmanager_framework["id"],
* roles=[{
* "role_arn": test_aws_iam_role["arn"],
* "role_type": "PROCESS_OWNER",
* }],
* scope={
* "aws_accounts": [{
* "id": current["accountId"],
* }],
* "aws_services": [{
* "service_name": "S3",
* }],
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var test = new Aws.Auditmanager.Assessment("test", new()
* {
* Name = "example",
* AssessmentReportsDestination = new Aws.Auditmanager.Inputs.AssessmentAssessmentReportsDestinationArgs
* {
* Destination = $"s3://{testAwsS3Bucket.Id}",
* DestinationType = "S3",
* },
* FrameworkId = testAwsAuditmanagerFramework.Id,
* Roles = new[]
* {
* new Aws.Auditmanager.Inputs.AssessmentRoleArgs
* {
* RoleArn = testAwsIamRole.Arn,
* RoleType = "PROCESS_OWNER",
* },
* },
* Scope = new Aws.Auditmanager.Inputs.AssessmentScopeArgs
* {
* AwsAccounts = new[]
* {
* new Aws.Auditmanager.Inputs.AssessmentScopeAwsAccountArgs
* {
* Id = current.AccountId,
* },
* },
* AwsServices = new[]
* {
* new Aws.Auditmanager.Inputs.AssessmentScopeAwsServiceArgs
* {
* ServiceName = "S3",
* },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/auditmanager"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := auditmanager.NewAssessment(ctx, "test", &auditmanager.AssessmentArgs{
* Name: pulumi.String("example"),
* AssessmentReportsDestination: &auditmanager.AssessmentAssessmentReportsDestinationArgs{
* Destination: pulumi.Sprintf("s3://%v", testAwsS3Bucket.Id),
* DestinationType: pulumi.String("S3"),
* },
* FrameworkId: pulumi.Any(testAwsAuditmanagerFramework.Id),
* Roles: auditmanager.AssessmentRoleArray{
* &auditmanager.AssessmentRoleArgs{
* RoleArn: pulumi.Any(testAwsIamRole.Arn),
* RoleType: pulumi.String("PROCESS_OWNER"),
* },
* },
* Scope: &auditmanager.AssessmentScopeArgs{
* AwsAccounts: auditmanager.AssessmentScopeAwsAccountArray{
* &auditmanager.AssessmentScopeAwsAccountArgs{
* Id: pulumi.Any(current.AccountId),
* },
* },
* AwsServices: auditmanager.AssessmentScopeAwsServiceArray{
* &auditmanager.AssessmentScopeAwsServiceArgs{
* ServiceName: pulumi.String("S3"),
* },
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.auditmanager.Assessment;
* import com.pulumi.aws.auditmanager.AssessmentArgs;
* import com.pulumi.aws.auditmanager.inputs.AssessmentAssessmentReportsDestinationArgs;
* import com.pulumi.aws.auditmanager.inputs.AssessmentRoleArgs;
* import com.pulumi.aws.auditmanager.inputs.AssessmentScopeArgs;
* import java.util.List;
* import java.util.ArrayList;
* 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 Assessment("test", AssessmentArgs.builder()
* .name("example")
* .assessmentReportsDestination(AssessmentAssessmentReportsDestinationArgs.builder()
* .destination(String.format("s3://%s", testAwsS3Bucket.id()))
* .destinationType("S3")
* .build())
* .frameworkId(testAwsAuditmanagerFramework.id())
* .roles(AssessmentRoleArgs.builder()
* .roleArn(testAwsIamRole.arn())
* .roleType("PROCESS_OWNER")
* .build())
* .scope(AssessmentScopeArgs.builder()
* .awsAccounts(AssessmentScopeAwsAccountArgs.builder()
* .id(current.accountId())
* .build())
* .awsServices(AssessmentScopeAwsServiceArgs.builder()
* .serviceName("S3")
* .build())
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* test:
* type: aws:auditmanager:Assessment
* properties:
* name: example
* assessmentReportsDestination:
* destination: s3://${testAwsS3Bucket.id}
* destinationType: S3
* frameworkId: ${testAwsAuditmanagerFramework.id}
* roles:
* - roleArn: ${testAwsIamRole.arn}
* roleType: PROCESS_OWNER
* scope:
* awsAccounts:
* - id: ${current.accountId}
* awsServices:
* - serviceName: S3
* ```
*
* ## Import
* Using `pulumi import`, import Audit Manager Assessments using the assessment `id`. For example:
* ```sh
* $ pulumi import aws:auditmanager/assessment:Assessment example abc123-de45
* ```
*/
public class Assessment internal constructor(
override val javaResource: com.pulumi.aws.auditmanager.Assessment,
) : KotlinCustomResource(javaResource, AssessmentMapper) {
/**
* Amazon Resource Name (ARN) of the assessment.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* Assessment report storage destination configuration. See `assessment_reports_destination` below.
*/
public val assessmentReportsDestination: Output?
get() = javaResource.assessmentReportsDestination().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> assessmentAssessmentReportsDestinationToKotlin(args0) })
}).orElse(null)
})
/**
* Description of the assessment.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Unique identifier of the framework the assessment will be created from.
*/
public val frameworkId: Output
get() = javaResource.frameworkId().applyValue({ args0 -> args0 })
/**
* Name of the assessment.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* List of roles for the assessment. See `roles` below.
*/
public val roles: Output>
get() = javaResource.roles().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
assessmentRoleToKotlin(args0)
})
})
})
/**
* Complete list of all roles with access to the assessment. This includes both roles explicitly configured via the `roles` block, and any roles which have access to all Audit Manager assessments by default.
*/
public val rolesAlls: Output>
get() = javaResource.rolesAlls().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
assessmentRolesAllToKotlin(args0)
})
})
})
/**
* Amazon Web Services accounts and services that are in scope for the assessment. See `scope` below.
* The following arguments are optional:
*/
public val scope: Output?
get() = javaResource.scope().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
assessmentScopeToKotlin(args0)
})
}).orElse(null)
})
/**
* Status of the assessment. Valid values are `ACTIVE` and `INACTIVE`.
*/
public val status: Output
get() = javaResource.status().applyValue({ args0 -> args0 })
/**
* A map of tags to assign to the assessment. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
@Deprecated(
message = """
Please use `tags` instead.
""",
)
public val tagsAll: Output>
get() = javaResource.tagsAll().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
}
public object AssessmentMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.auditmanager.Assessment::class == javaResource::class
override fun map(javaResource: Resource): Assessment = Assessment(
javaResource as
com.pulumi.aws.auditmanager.Assessment,
)
}
/**
* @see [Assessment].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Assessment].
*/
public suspend fun assessment(name: String, block: suspend AssessmentResourceBuilder.() -> Unit): Assessment {
val builder = AssessmentResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Assessment].
* @param name The _unique_ name of the resulting resource.
*/
public fun assessment(name: String): Assessment {
val builder = AssessmentResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy