awsauditmanager

package
v1.141.0-devpreview Latest Latest
Warning

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

Go to latest
Published: Jan 27, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

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
	AssessmentReportsDestination() interface{}
	SetAssessmentReportsDestination(val interface{})
	AttrArn() *string
	AttrAssessmentId() *string
	AttrCreationTime() awscdk.IResolvable
	AttrDelegations() awscdk.IResolvable
	AwsAccount() interface{}
	SetAwsAccount(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	FrameworkId() *string
	SetFrameworkId(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Roles() interface{}
	SetRoles(val interface{})
	Scope() interface{}
	SetScope(val interface{})
	Stack() awscdk.Stack
	Status() *string
	SetStatus(val *string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

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

The `AWS::AuditManager::Assessment` resource is an AWS 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.

TODO: EXAMPLE

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{} `json:"assessmentReportsDestination" yaml:"assessmentReportsDestination"`
	// The AWS account that's associated with the assessment.
	AwsAccount interface{} `json:"awsAccount" yaml:"awsAccount"`
	// The description of the assessment.
	Description *string `json:"description" yaml:"description"`
	// The unique identifier for the framework.
	FrameworkId *string `json:"frameworkId" yaml:"frameworkId"`
	// The name of the assessment.
	Name *string `json:"name" yaml:"name"`
	// The roles that are associated with the assessment.
	Roles interface{} `json:"roles" yaml:"roles"`
	// The wrapper of AWS accounts and services that are in scope for the assessment.
	Scope interface{} `json:"scope" yaml:"scope"`
	// The overall status of the assessment.
	Status *string `json:"status" yaml:"status"`
	// The tags that are associated with the assessment.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnAssessment`.

TODO: EXAMPLE

type CfnAssessment_AWSAccountProperty

type CfnAssessment_AWSAccountProperty struct {
	// The email address that's associated with the AWS account .
	EmailAddress *string `json:"emailAddress" yaml:"emailAddress"`
	// The identifier for the AWS account .
	Id *string `json:"id" yaml:"id"`
	// The name of the AWS account .
	Name *string `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.

TODO: EXAMPLE

type CfnAssessment_AWSServiceProperty

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

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

TODO: EXAMPLE

type CfnAssessment_AssessmentReportsDestinationProperty

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

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

TODO: EXAMPLE

type CfnAssessment_DelegationProperty

type CfnAssessment_DelegationProperty struct {
	// The identifier for the assessment that's associated with the delegation.
	AssessmentId *string `json:"assessmentId" yaml:"assessmentId"`
	// The name of the assessment that's associated with the delegation.
	AssessmentName *string `json:"assessmentName" yaml:"assessmentName"`
	// The comment that's related to the delegation.
	Comment *string `json:"comment" yaml:"comment"`
	// The identifier for the control set that's associated with the delegation.
	ControlSetId *string `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 `json:"createdBy" yaml:"createdBy"`
	// Specifies when the delegation was created.
	CreationTime *float64 `json:"creationTime" yaml:"creationTime"`
	// The unique identifier for the delegation.
	Id *string `json:"id" yaml:"id"`
	// Specifies when the delegation was last updated.
	LastUpdated *float64 `json:"lastUpdated" yaml:"lastUpdated"`
	// The Amazon Resource Name (ARN) of the IAM role.
	RoleArn *string `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 `json:"roleType" yaml:"roleType"`
	// The status of the delegation.
	Status *string `json:"status" yaml:"status"`
}

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

TODO: EXAMPLE

type CfnAssessment_RoleProperty

type CfnAssessment_RoleProperty struct {
	// The Amazon Resource Name (ARN) of the IAM role.
	RoleArn *string `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 `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).

TODO: EXAMPLE

type CfnAssessment_ScopeProperty

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

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

TODO: EXAMPLE

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL