awsauditmanager

package
v1.182.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 7, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::AuditManager Construct Library

This module is part of the AWS Cloud Development Kit project.

import auditmanager "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::AuditManager.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnAssessment_CFN_RESOURCE_TYPE_NAME 

func CfnAssessment_CFN_RESOURCE_TYPE_NAME() *string

func CfnAssessment_IsCfnElement 

func CfnAssessment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnAssessment_IsCfnResource 

func CfnAssessment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnAssessment_IsConstruct 

func CfnAssessment_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnAssessment_Override 

func NewCfnAssessment_Override(c CfnAssessment, scope awscdk.Construct, id *string, props *CfnAssessmentProps)

Create a new `AWS::AuditManager::Assessment`.

Types

type CfnAssessment 

type CfnAssessment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The destination that evidence reports are stored in for the assessment.
	AssessmentReportsDestination() interface{}
	SetAssessmentReportsDestination(val interface{})
	// The Amazon Resource Name (ARN) of the assessment.
	//
	// For example, `arn:aws:auditmanager:us-east-1:123456789012:assessment/111A1A1A-22B2-33C3-DDD4-55E5E5E555E5` .
	AttrArn() *string
	// The unique identifier for the assessment.
	//
	// For example, `111A1A1A-22B2-33C3-DDD4-55E5E5E555E5` .
	AttrAssessmentId() *string
	// The time when the assessment was created.
	//
	// For example, `1607582033.373` .
	AttrCreationTime() awscdk.IResolvable
	// The delegations that are associated with the assessment.
	AttrDelegations() awscdk.IResolvable
	// The AWS account that's associated with the assessment.
	AwsAccount() interface{}
	SetAwsAccount(val interface{})
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*string
	// The description of the assessment.
	Description() *string
	SetDescription(val *string)
	// The unique identifier for the framework.
	FrameworkId() *string
	SetFrameworkId(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The name of the assessment.
	Name() *string
	SetName(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	// Experimental.
	Ref() *string
	// The roles that are associated with the assessment.
	Roles() interface{}
	SetRoles(val interface{})
	// The wrapper of AWS accounts and services that are in scope for the assessment.
	Scope() interface{}
	SetScope(val interface{})
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// The overall status of the assessment.
	//
	// When you create a new assessment, the initial `Status` value is always `ACTIVE` . When you create an assessment, even if you specify the value as `INACTIVE` , the value overrides to `ACTIVE` .
	//
	// After you create an assessment, you can change the value of the `Status` property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status to `INACTIVE` .
	Status() *string
	SetStatus(val *string)
	// The tags that are associated with the assessment.
	Tags() awscdk.TagManager
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::AuditManager::Assessment`.

The `AWS::AuditManager::Assessment` resource is an Audit Manager resource type that defines the scope of audit evidence collected by Audit Manager . An Audit Manager assessment is an implementation of an Audit Manager framework.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAssessment := awscdk.Aws_auditmanager.NewCfnAssessment(this, jsii.String("MyCfnAssessment"), &cfnAssessmentProps{
	assessmentReportsDestination: &assessmentReportsDestinationProperty{
		destination: jsii.String("destination"),
		destinationType: jsii.String("destinationType"),
	},
	awsAccount: &aWSAccountProperty{
		emailAddress: jsii.String("emailAddress"),
		id: jsii.String("id"),
		name: jsii.String("name"),
	},
	description: jsii.String("description"),
	frameworkId: jsii.String("frameworkId"),
	name: jsii.String("name"),
	roles: []interface{}{
		&roleProperty{
			roleArn: jsii.String("roleArn"),
			roleType: jsii.String("roleType"),
		},
	},
	scope: &scopeProperty{
		awsAccounts: []interface{}{
			&aWSAccountProperty{
				emailAddress: jsii.String("emailAddress"),
				id: jsii.String("id"),
				name: jsii.String("name"),
			},
		},
		awsServices: []interface{}{
			&aWSServiceProperty{
				serviceName: jsii.String("serviceName"),
			},
		},
	},
	status: jsii.String("status"),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
})

func NewCfnAssessment 

func NewCfnAssessment(scope awscdk.Construct, id *string, props *CfnAssessmentProps) CfnAssessment

Create a new `AWS::AuditManager::Assessment`.

type CfnAssessmentProps 

type CfnAssessmentProps struct {
	// The destination that evidence reports are stored in for the assessment.
	AssessmentReportsDestination interface{} `field:"optional" json:"assessmentReportsDestination" yaml:"assessmentReportsDestination"`
	// The AWS account that's associated with the assessment.
	AwsAccount interface{} `field:"optional" json:"awsAccount" yaml:"awsAccount"`
	// The description of the assessment.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The unique identifier for the framework.
	FrameworkId *string `field:"optional" json:"frameworkId" yaml:"frameworkId"`
	// The name of the assessment.
	Name *string `field:"optional" json:"name" yaml:"name"`
	// The roles that are associated with the assessment.
	Roles interface{} `field:"optional" json:"roles" yaml:"roles"`
	// The wrapper of AWS accounts and services that are in scope for the assessment.
	Scope interface{} `field:"optional" json:"scope" yaml:"scope"`
	// The overall status of the assessment.
	//
	// When you create a new assessment, the initial `Status` value is always `ACTIVE` . When you create an assessment, even if you specify the value as `INACTIVE` , the value overrides to `ACTIVE` .
	//
	// After you create an assessment, you can change the value of the `Status` property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status to `INACTIVE` .
	Status *string `field:"optional" json:"status" yaml:"status"`
	// The tags that are associated with the assessment.
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnAssessment`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAssessmentProps := &cfnAssessmentProps{
	assessmentReportsDestination: &assessmentReportsDestinationProperty{
		destination: jsii.String("destination"),
		destinationType: jsii.String("destinationType"),
	},
	awsAccount: &aWSAccountProperty{
		emailAddress: jsii.String("emailAddress"),
		id: jsii.String("id"),
		name: jsii.String("name"),
	},
	description: jsii.String("description"),
	frameworkId: jsii.String("frameworkId"),
	name: jsii.String("name"),
	roles: []interface{}{
		&roleProperty{
			roleArn: jsii.String("roleArn"),
			roleType: jsii.String("roleType"),
		},
	},
	scope: &scopeProperty{
		awsAccounts: []interface{}{
			&aWSAccountProperty{
				emailAddress: jsii.String("emailAddress"),
				id: jsii.String("id"),
				name: jsii.String("name"),
			},
		},
		awsServices: []interface{}{
			&aWSServiceProperty{
				serviceName: jsii.String("serviceName"),
			},
		},
	},
	status: jsii.String("status"),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
}

type CfnAssessment_AWSAccountProperty 

type CfnAssessment_AWSAccountProperty struct {
	// The email address that's associated with the AWS account .
	EmailAddress *string `field:"optional" json:"emailAddress" yaml:"emailAddress"`
	// The identifier for the AWS account .
	Id *string `field:"optional" json:"id" yaml:"id"`
	// The name of the AWS account .
	Name *string `field:"optional" json:"name" yaml:"name"`
}

The `AWSAccount` property type specifies the wrapper of the AWS account details, such as account ID, email address, and so on.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

aWSAccountProperty := &aWSAccountProperty{
	emailAddress: jsii.String("emailAddress"),
	id: jsii.String("id"),
	name: jsii.String("name"),
}

type CfnAssessment_AWSServiceProperty 

type CfnAssessment_AWSServiceProperty struct {
	// The name of the AWS service .
	ServiceName *string `field:"optional" json:"serviceName" yaml:"serviceName"`
}

The `AWSService` property type specifies an AWS service such as Amazon S3 , AWS CloudTrail , and so on.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

aWSServiceProperty := &aWSServiceProperty{
	serviceName: jsii.String("serviceName"),
}

type CfnAssessment_AssessmentReportsDestinationProperty 

type CfnAssessment_AssessmentReportsDestinationProperty struct {
	// The destination of the assessment report.
	Destination *string `field:"optional" json:"destination" yaml:"destination"`
	// The destination type, such as Amazon S3.
	DestinationType *string `field:"optional" json:"destinationType" yaml:"destinationType"`
}

The `AssessmentReportsDestination` property type specifies the location in which AWS Audit Manager saves assessment reports for the given assessment.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

assessmentReportsDestinationProperty := &assessmentReportsDestinationProperty{
	destination: jsii.String("destination"),
	destinationType: jsii.String("destinationType"),
}

type CfnAssessment_DelegationProperty 

type CfnAssessment_DelegationProperty struct {
	// The identifier for the assessment that's associated with the delegation.
	AssessmentId *string `field:"optional" json:"assessmentId" yaml:"assessmentId"`
	// The name of the assessment that's associated with the delegation.
	AssessmentName *string `field:"optional" json:"assessmentName" yaml:"assessmentName"`
	// The comment that's related to the delegation.
	Comment *string `field:"optional" json:"comment" yaml:"comment"`
	// The identifier for the control set that's associated with the delegation.
	ControlSetId *string `field:"optional" json:"controlSetId" yaml:"controlSetId"`
	// The IAM user or role that created the delegation.
	//
	// *Minimum* : `1`
	//
	// *Maximum* : `100`
	//
	// *Pattern* : `^[a-zA-Z0-9-_()\\[\\]\\s]+$`.
	CreatedBy *string `field:"optional" json:"createdBy" yaml:"createdBy"`
	// Specifies when the delegation was created.
	CreationTime *float64 `field:"optional" json:"creationTime" yaml:"creationTime"`
	// The unique identifier for the delegation.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// Specifies when the delegation was last updated.
	LastUpdated *float64 `field:"optional" json:"lastUpdated" yaml:"lastUpdated"`
	// The Amazon Resource Name (ARN) of the IAM role.
	RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"`
	// The type of customer persona.
	//
	// > In `CreateAssessment` , `roleType` can only be `PROCESS_OWNER` .
	// >
	// > In `UpdateSettings` , `roleType` can only be `PROCESS_OWNER` .
	// >
	// > In `BatchCreateDelegationByAssessment` , `roleType` can only be `RESOURCE_OWNER` .
	RoleType *string `field:"optional" json:"roleType" yaml:"roleType"`
	// The status of the delegation.
	Status *string `field:"optional" json:"status" yaml:"status"`
}

The `Delegation` property type specifies the assignment of a control set to a delegate for review.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

delegationProperty := &delegationProperty{
	assessmentId: jsii.String("assessmentId"),
	assessmentName: jsii.String("assessmentName"),
	comment: jsii.String("comment"),
	controlSetId: jsii.String("controlSetId"),
	createdBy: jsii.String("createdBy"),
	creationTime: jsii.Number(123),
	id: jsii.String("id"),
	lastUpdated: jsii.Number(123),
	roleArn: jsii.String("roleArn"),
	roleType: jsii.String("roleType"),
	status: jsii.String("status"),
}

type CfnAssessment_RoleProperty 

type CfnAssessment_RoleProperty struct {
	// The Amazon Resource Name (ARN) of the IAM role.
	RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"`
	// The type of customer persona.
	//
	// > In `CreateAssessment` , `roleType` can only be `PROCESS_OWNER` .
	// >
	// > In `UpdateSettings` , `roleType` can only be `PROCESS_OWNER` .
	// >
	// > In `BatchCreateDelegationByAssessment` , `roleType` can only be `RESOURCE_OWNER` .
	RoleType *string `field:"optional" json:"roleType" yaml:"roleType"`
}

The `Role` property type specifies the wrapper that contains AWS Audit Manager role information, such as the role type and IAM Amazon Resource Name (ARN).

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

roleProperty := &roleProperty{
	roleArn: jsii.String("roleArn"),
	roleType: jsii.String("roleType"),
}

type CfnAssessment_ScopeProperty 

type CfnAssessment_ScopeProperty struct {
	// The AWS accounts that are included in the scope of the assessment.
	AwsAccounts interface{} `field:"optional" json:"awsAccounts" yaml:"awsAccounts"`
	// The AWS services that are included in the scope of the assessment.
	AwsServices interface{} `field:"optional" json:"awsServices" yaml:"awsServices"`
}

The `Scope` property type specifies the wrapper that contains the AWS accounts and services that are in scope for the assessment.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

scopeProperty := &scopeProperty{
	awsAccounts: []interface{}{
		&aWSAccountProperty{
			emailAddress: jsii.String("emailAddress"),
			id: jsii.String("id"),
			name: jsii.String("name"),
		},
	},
	awsServices: []interface{}{
		&aWSServiceProperty{
			serviceName: jsii.String("serviceName"),
		},
	},
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.