Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. auditmanager
  5. AssessmentDelegation
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.auditmanager.AssessmentDelegation

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS Audit Manager Assessment Delegation.

    Example Usage

    Basic Usage

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

const example = new aws.auditmanager.AssessmentDelegation("example", {
    assessmentId: exampleAwsAuditmanagerAssessment.id,
    roleArn: exampleAwsIamRole.arn,
    roleType: "RESOURCE_OWNER",
    controlSetId: "example",
});

    import pulumi
import pulumi_aws as aws

example = aws.auditmanager.AssessmentDelegation("example",
    assessment_id=example_aws_auditmanager_assessment["id"],
    role_arn=example_aws_iam_role["arn"],
    role_type="RESOURCE_OWNER",
    control_set_id="example")

    package main

import (
	"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.NewAssessmentDelegation(ctx, "example", &auditmanager.AssessmentDelegationArgs{
			AssessmentId: pulumi.Any(exampleAwsAuditmanagerAssessment.Id),
			RoleArn:      pulumi.Any(exampleAwsIamRole.Arn),
			RoleType:     pulumi.String("RESOURCE_OWNER"),
			ControlSetId: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Auditmanager.AssessmentDelegation("example", new()
    {
        AssessmentId = exampleAwsAuditmanagerAssessment.Id,
        RoleArn = exampleAwsIamRole.Arn,
        RoleType = "RESOURCE_OWNER",
        ControlSetId = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.auditmanager.AssessmentDelegation;
import com.pulumi.aws.auditmanager.AssessmentDelegationArgs;
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 example = new AssessmentDelegation("example", AssessmentDelegationArgs.builder()
            .assessmentId(exampleAwsAuditmanagerAssessment.id())
            .roleArn(exampleAwsIamRole.arn())
            .roleType("RESOURCE_OWNER")
            .controlSetId("example")
            .build());

    }
}

    resources:
  example:
    type: aws:auditmanager:AssessmentDelegation
    properties:
      assessmentId: ${exampleAwsAuditmanagerAssessment.id}
      roleArn: ${exampleAwsIamRole.arn}
      roleType: RESOURCE_OWNER
      controlSetId: example

    Create AssessmentDelegation Resource

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

    Constructor syntax

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

@overload
def AssessmentDelegation(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         assessment_id: Optional[str] = None,
                         control_set_id: Optional[str] = None,
                         role_arn: Optional[str] = None,
                         role_type: Optional[str] = None,
                         comment: Optional[str] = None)
    func NewAssessmentDelegation(ctx *Context, name string, args AssessmentDelegationArgs, opts ...ResourceOption) (*AssessmentDelegation, error)
    public AssessmentDelegation(string name, AssessmentDelegationArgs args, CustomResourceOptions? opts = null)
    public AssessmentDelegation(String name, AssessmentDelegationArgs args)
public AssessmentDelegation(String name, AssessmentDelegationArgs args, CustomResourceOptions options)

    type: aws:auditmanager:AssessmentDelegation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AssessmentDelegationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AssessmentDelegationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AssessmentDelegationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AssessmentDelegationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AssessmentDelegationArgs
    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 assessmentDelegationResource = new Aws.Auditmanager.AssessmentDelegation("assessmentDelegationResource", new()
{
    AssessmentId = "string",
    ControlSetId = "string",
    RoleArn = "string",
    RoleType = "string",
    Comment = "string",
});

    example, err := auditmanager.NewAssessmentDelegation(ctx, "assessmentDelegationResource", &auditmanager.AssessmentDelegationArgs{
	AssessmentId: pulumi.String("string"),
	ControlSetId: pulumi.String("string"),
	RoleArn:      pulumi.String("string"),
	RoleType:     pulumi.String("string"),
	Comment:      pulumi.String("string"),
})

    var assessmentDelegationResource = new AssessmentDelegation("assessmentDelegationResource", AssessmentDelegationArgs.builder()
    .assessmentId("string")
    .controlSetId("string")
    .roleArn("string")
    .roleType("string")
    .comment("string")
    .build());

    assessment_delegation_resource = aws.auditmanager.AssessmentDelegation("assessmentDelegationResource",
    assessment_id="string",
    control_set_id="string",
    role_arn="string",
    role_type="string",
    comment="string")

    const assessmentDelegationResource = new aws.auditmanager.AssessmentDelegation("assessmentDelegationResource", {
    assessmentId: "string",
    controlSetId: "string",
    roleArn: "string",
    roleType: "string",
    comment: "string",
});

    type: aws:auditmanager:AssessmentDelegation
properties:
    assessmentId: string
    comment: string
    controlSetId: string
    roleArn: string
    roleType: string

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

    AssessmentId string
    Identifier for the assessment.
    ControlSetId string
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    RoleArn string
    Amazon Resource Name (ARN) of the IAM role.
    RoleType string

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    Comment string
    Comment describing the delegation request.
    AssessmentId string
    Identifier for the assessment.
    ControlSetId string
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    RoleArn string
    Amazon Resource Name (ARN) of the IAM role.
    RoleType string

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    Comment string
    Comment describing the delegation request.
    assessmentId String
    Identifier for the assessment.
    controlSetId String
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    roleArn String
    Amazon Resource Name (ARN) of the IAM role.
    roleType String

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    comment String
    Comment describing the delegation request.
    assessmentId string
    Identifier for the assessment.
    controlSetId string
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    roleArn string
    Amazon Resource Name (ARN) of the IAM role.
    roleType string

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    comment string
    Comment describing the delegation request.
    assessment_id str
    Identifier for the assessment.
    control_set_id str
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    role_arn str
    Amazon Resource Name (ARN) of the IAM role.
    role_type str

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    comment str
    Comment describing the delegation request.
    assessmentId String
    Identifier for the assessment.
    controlSetId String
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    roleArn String
    Amazon Resource Name (ARN) of the IAM role.
    roleType String

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    comment String
    Comment describing the delegation request.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AssessmentDelegation resource produces the following output properties:

    DelegationId string
    Unique identifier for the delegation.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the delegation.
    DelegationId string
    Unique identifier for the delegation.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the delegation.
    delegationId String
    Unique identifier for the delegation.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the delegation.
    delegationId string
    Unique identifier for the delegation.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the delegation.
    delegation_id str
    Unique identifier for the delegation.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the delegation.
    delegationId String
    Unique identifier for the delegation.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the delegation.

    Look up Existing AssessmentDelegation Resource

    Get an existing AssessmentDelegation 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?: AssessmentDelegationState, opts?: CustomResourceOptions): AssessmentDelegation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assessment_id: Optional[str] = None,
        comment: Optional[str] = None,
        control_set_id: Optional[str] = None,
        delegation_id: Optional[str] = None,
        role_arn: Optional[str] = None,
        role_type: Optional[str] = None,
        status: Optional[str] = None) -> AssessmentDelegation
    func GetAssessmentDelegation(ctx *Context, name string, id IDInput, state *AssessmentDelegationState, opts ...ResourceOption) (*AssessmentDelegation, error)
    public static AssessmentDelegation Get(string name, Input<string> id, AssessmentDelegationState? state, CustomResourceOptions? opts = null)
    public static AssessmentDelegation get(String name, Output<String> id, AssessmentDelegationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AssessmentId string
    Identifier for the assessment.
    Comment string
    Comment describing the delegation request.
    ControlSetId string
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    DelegationId string
    Unique identifier for the delegation.
    RoleArn string
    Amazon Resource Name (ARN) of the IAM role.
    RoleType string

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    Status string
    Status of the delegation.
    AssessmentId string
    Identifier for the assessment.
    Comment string
    Comment describing the delegation request.
    ControlSetId string
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    DelegationId string
    Unique identifier for the delegation.
    RoleArn string
    Amazon Resource Name (ARN) of the IAM role.
    RoleType string

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    Status string
    Status of the delegation.
    assessmentId String
    Identifier for the assessment.
    comment String
    Comment describing the delegation request.
    controlSetId String
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    delegationId String
    Unique identifier for the delegation.
    roleArn String
    Amazon Resource Name (ARN) of the IAM role.
    roleType String

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    status String
    Status of the delegation.
    assessmentId string
    Identifier for the assessment.
    comment string
    Comment describing the delegation request.
    controlSetId string
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    delegationId string
    Unique identifier for the delegation.
    roleArn string
    Amazon Resource Name (ARN) of the IAM role.
    roleType string

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    status string
    Status of the delegation.
    assessment_id str
    Identifier for the assessment.
    comment str
    Comment describing the delegation request.
    control_set_id str
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    delegation_id str
    Unique identifier for the delegation.
    role_arn str
    Amazon Resource Name (ARN) of the IAM role.
    role_type str

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    status str
    Status of the delegation.
    assessmentId String
    Identifier for the assessment.
    comment String
    Comment describing the delegation request.
    controlSetId String
    Assessment control set name. This value is the control set name used during assessment creation (not the AWS-generated ID). The _id suffix on this attribute has been preserved to be consistent with the underlying AWS API.
    delegationId String
    Unique identifier for the delegation.
    roleArn String
    Amazon Resource Name (ARN) of the IAM role.
    roleType String

    Type of customer persona. For assessment delegation, type must always be RESOURCE_OWNER.

    The following arguments are optional:

    status String
    Status of the delegation.

    Import

    Using pulumi import, import Audit Manager Assessment Delegation using the id. For example:

    $ pulumi import aws:auditmanager/assessmentDelegation:AssessmentDelegation example abcdef-123456,arn:aws:iam::123456789012:role/example,example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws