alerting

package
v0.0.82 Latest Latest
Warning

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

 Go to latest Published: Jun 24, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConfigComplianceChange_IsConstruct added in v0.0.80 

func ConfigComplianceChange_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func ConfigComplianceChange_IsOwnedResource added in v0.0.80 

func ConfigComplianceChange_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func ConfigComplianceChange_IsResource added in v0.0.80 

func ConfigComplianceChange_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func ConfigComplianceChange_MATCH_TYPE added in v0.0.80 

func ConfigComplianceChange_MATCH_TYPE() *string

func DescriptionBuilderIterator_IsConstruct 

func DescriptionBuilderIterator_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func DescriptionBuilderSection_IsConstruct 

func DescriptionBuilderSection_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func DescriptionBuilder_IsConstruct 

func DescriptionBuilder_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func Discord_DEFAULT_NAME added in v0.0.82 

func Discord_DEFAULT_NAME() *string

func Discord_IsConstruct added in v0.0.82 

func Discord_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func Discord_IsOwnedResource added in v0.0.82 

func Discord_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func Discord_IsResource added in v0.0.82 

func Discord_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func Discord_MESSAGES_ENDPOINT added in v0.0.82 

func Discord_MESSAGES_ENDPOINT() *string

func EcrScanFinding_IsConstruct 

func EcrScanFinding_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func EcrScanFinding_IsOwnedResource 

func EcrScanFinding_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func EcrScanFinding_IsResource 

func EcrScanFinding_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func EcrScanFinding_MATCH_TYPE 

func EcrScanFinding_MATCH_TYPE() *string

func EcrScanFinding_SEVERITIES 

func EcrScanFinding_SEVERITIES() *[]EcrImageScanSeverity

func GuardDutyFinding_IsConstruct 

func GuardDutyFinding_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func GuardDutyFinding_IsOwnedResource 

func GuardDutyFinding_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func GuardDutyFinding_IsResource 

func GuardDutyFinding_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func GuardDutyFinding_MATCH_TYPE 

func GuardDutyFinding_MATCH_TYPE() *string

func GuardDutyFinding_SEVERITIES 

func GuardDutyFinding_SEVERITIES() *[]GuardDutySeverity

func GuardDutySeverity_All 

func GuardDutySeverity_All() *[]GuardDutySeverity

func GuardDutySeverity_Custom 

func GuardDutySeverity_Custom(levels ...GuardDutySeverity) *[]GuardDutySeverity

func GuardDutySeverity_Threshold 

func GuardDutySeverity_Threshold(level GuardDutySeverity) *[]GuardDutySeverity

func InspectorFinding_IsConstruct 

func InspectorFinding_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func InspectorFinding_IsOwnedResource 

func InspectorFinding_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func InspectorFinding_IsResource 

func InspectorFinding_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func InspectorFinding_MATCH_TYPE 

func InspectorFinding_MATCH_TYPE() *string

func InspectorFinding_SEVERITIES 

func InspectorFinding_SEVERITIES() *[]InspectorSeverity

func InspectorSeverity_All 

func InspectorSeverity_All() *[]InspectorSeverity

func InspectorSeverity_Custom 

func InspectorSeverity_Custom(levels ...InspectorSeverity) *[]InspectorSeverity

func InspectorSeverity_Threshold 

func InspectorSeverity_Threshold(level InspectorSeverity) *[]InspectorSeverity

func IssueManager_IsConstruct 

func IssueManager_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func IssueManager_IsOwnedResource 

func IssueManager_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func IssueManager_IsResource 

func IssueManager_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func IssueParserPluginBase_IsConstruct 

func IssueParserPluginBase_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func IssueParserPluginBase_IsOwnedResource 

func IssueParserPluginBase_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func IssueParserPluginBase_IsResource 

func IssueParserPluginBase_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func IssuePluginBase_IsConstruct 

func IssuePluginBase_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func IssuePluginBase_IsOwnedResource 

func IssuePluginBase_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func IssuePluginBase_IsResource 

func IssuePluginBase_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func IssueTrigger_IsConstruct 

func IssueTrigger_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func JiraTicket_DEFAULT_NAME 

func JiraTicket_DEFAULT_NAME() *string

func JiraTicket_IsConstruct 

func JiraTicket_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func JiraTicket_IsOwnedResource 

func JiraTicket_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func JiraTicket_IsResource 

func JiraTicket_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func NewConfigComplianceChange_Override added in v0.0.80 

func NewConfigComplianceChange_Override(c ConfigComplianceChange, scope constructs.IConstruct, id *string, props *ConfigComplianceChangeProps)

func NewDescriptionBuilderIterator_Override 

func NewDescriptionBuilderIterator_Override(d DescriptionBuilderIterator, scope constructs.IConstruct, id *string, props *DescriptionBuilderIteratorProps)

func NewDescriptionBuilderSection_Override 

func NewDescriptionBuilderSection_Override(d DescriptionBuilderSection, scope constructs.IConstruct, id *string, props *DescriptionBuilderSectionProps)

func NewDescriptionBuilder_Override 

func NewDescriptionBuilder_Override(d DescriptionBuilder, scope constructs.IConstruct, props *DescriptionBuilderProps)

func NewDiscord_Override added in v0.0.82 

func NewDiscord_Override(d Discord, scope constructs.IConstruct, id *string, props *DiscordProps)

Creates a new instance of the JiraTicket class.

func NewEcrImageScanSeverityConfiguration_Override 

func NewEcrImageScanSeverityConfiguration_Override(e EcrImageScanSeverityConfiguration)

func NewEcrScanFinding_Override 

func NewEcrScanFinding_Override(e EcrScanFinding, scope constructs.IConstruct, id *string, props *EcrScanFindingProps)

func NewGuardDutyFinding_Override 

func NewGuardDutyFinding_Override(g GuardDutyFinding, scope constructs.IConstruct, id *string, props *GuardDutyFindingProps)

func NewInspectorFinding_Override 

func NewInspectorFinding_Override(i InspectorFinding, scope constructs.IConstruct, id *string, props *InspectorFindingProps)

func NewIssueHander_Override 

func NewIssueHander_Override(i IssueHander)

func NewIssueHandlerOverride_Override 

func NewIssueHandlerOverride_Override(i IssueHandlerOverride, handler IIssueHandler, overrides *map[string]interface{})

func NewIssueManager_Override 

func NewIssueManager_Override(i IssueManager, scope constructs.IConstruct, id *string, props *IssueManagerProps)

func NewIssueParserPluginBase_Override 

func NewIssueParserPluginBase_Override(i IssueParserPluginBase, scope constructs.IConstruct, id *string, props *IssueParserPluginBaseProps)

func NewIssueParser_Override added in v0.0.80 

func NewIssueParser_Override(i IssueParser)

func NewIssuePluginBase_Override 

func NewIssuePluginBase_Override(i IssuePluginBase, scope constructs.IConstruct, id *string, props *IssuePluginBaseProps)

func NewIssueTrigger_Override 

func NewIssueTrigger_Override(i IssueTrigger, scope constructs.IConstruct, id *string, props *IssueTriggerProps)

func NewJiraTicket_Override 

func NewJiraTicket_Override(j JiraTicket, scope constructs.IConstruct, id *string, props *JiraTicketProps)

Creates a new instance of the JiraTicket class.

func NewOpenSearchEvent_Override 

func NewOpenSearchEvent_Override(o OpenSearchEvent, scope constructs.IConstruct, id *string, props *OpenSearchEventProps)

func NewSecurityHubFinding_Override 

func NewSecurityHubFinding_Override(s SecurityHubFinding, scope constructs.IConstruct, id *string, props *SecurityHubFindingProps)

func NewSecurityHubSeverityConfiguration_Override 

func NewSecurityHubSeverityConfiguration_Override(s SecurityHubSeverityConfiguration)

func OpenSearchEventSeverity_All 

func OpenSearchEventSeverity_All() *[]OpenSearchEventSeverity

func OpenSearchEventSeverity_Custom 

func OpenSearchEventSeverity_Custom(levels ...OpenSearchEventSeverity) *[]OpenSearchEventSeverity

func OpenSearchEventSeverity_Threshold 

func OpenSearchEventSeverity_Threshold(level OpenSearchEventSeverity) *[]OpenSearchEventSeverity

func OpenSearchEventType_All 

func OpenSearchEventType_All() *[]OpenSearchEventType

func OpenSearchEvent_IsConstruct 

func OpenSearchEvent_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func OpenSearchEvent_IsOwnedResource 

func OpenSearchEvent_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func OpenSearchEvent_IsResource 

func OpenSearchEvent_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func OpenSearchEvent_MATCH_TYPE 

func OpenSearchEvent_MATCH_TYPE() *string

func OpenSearchEvent_SEVERITIES 

func OpenSearchEvent_SEVERITIES() *[]OpenSearchEventSeverity

func SecurityHubFinding_IsConstruct 

func SecurityHubFinding_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func SecurityHubFinding_IsOwnedResource 

func SecurityHubFinding_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func SecurityHubFinding_IsResource 

func SecurityHubFinding_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func SecurityHubFinding_MATCH_TYPE 

func SecurityHubFinding_MATCH_TYPE() *string

func SecurityHubFinding_SEVERITIES 

func SecurityHubFinding_SEVERITIES() *[]SecurityHubSeverity

Types

type AddReferenceProps 

type AddReferenceProps struct {
	Value     *string         `field:"required" json:"value" yaml:"value"`
	Delimiter AppendDelimiter `field:"optional" json:"delimiter" yaml:"delimiter"`
	Label     *string         `field:"optional" json:"label" yaml:"label"`
	Required  *bool           `field:"optional" json:"required" yaml:"required"`
}

type AppendDelimiter 

type AppendDelimiter interface {
	Delimiter() *string
}

func AppendDelimiter_NEWLINE 

func AppendDelimiter_NEWLINE() AppendDelimiter

func AppendDelimiter_Of 

func AppendDelimiter_Of(delimiter *string) AppendDelimiter

func AppendDelimiter_PARAGRAPH 

func AppendDelimiter_PARAGRAPH() AppendDelimiter

type ConfigComplianceChange added in v0.0.80 

type ConfigComplianceChange interface {
	IssueParserPluginBase
	IIssueParser
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	Handler() awsstepfunctions.IStateMachine
	Logging() *StateMachineLogging
	MatchType() *string
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	Timeout() awscdk.Duration
	Triggers() *[]IssueTrigger
	AddDefaultTrigger() IssueTrigger
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Bind(_node constructs.IConstruct) *[]IssueTrigger
	BuildDescription() DescriptionBuilder
	BuildLogging() *awsstepfunctions.LogOptions
	BuildResourceUrl() awsstepfunctions.Chain
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	RegisterIssueTrigger(id *string, options *ConfigComplianceChangeRuleOptions) IssueTrigger
	// Returns a string representation of this construct.
	ToString() *string
}

func IssueParser_ConfigComplianceChange added in v0.0.80 

func IssueParser_ConfigComplianceChange(scope constructs.IConstruct, id *string, props *ConfigComplianceChangeProps) ConfigComplianceChange

func NewConfigComplianceChange added in v0.0.80 

func NewConfigComplianceChange(scope constructs.IConstruct, id *string, props *ConfigComplianceChangeProps) ConfigComplianceChange

type ConfigComplianceChangeProps added in v0.0.80 

type ConfigComplianceChangeProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region    *string              `field:"optional" json:"region" yaml:"region"`
	Logging   *StateMachineLogging `field:"optional" json:"logging" yaml:"logging"`
	MatchType *string              `field:"optional" json:"matchType" yaml:"matchType"`
	Name      *string              `field:"optional" json:"name" yaml:"name"`
	Timeout   awscdk.Duration      `field:"optional" json:"timeout" yaml:"timeout"`
}

type ConfigComplianceChangeRuleOptions added in v0.0.80 

type ConfigComplianceChangeRuleOptions struct {
	IncludeSecurityHub *bool                   `field:"optional" json:"includeSecurityHub" yaml:"includeSecurityHub"`
	Overrides          *[]IssueHandlerOverride `field:"optional" json:"overrides" yaml:"overrides"`
	Severity           *[]InspectorSeverity    `field:"optional" json:"severity" yaml:"severity"`
}

type DescriptionBuilder 

type DescriptionBuilder interface {
	constructs.Construct
	IDelayedChainable
	IDescriptionBuilderComponent
	Classifier() *string
	InitialDescription() *string
	InitializeNode() awsstepfunctions.IChainable
	// The tree node.
	Node() constructs.Node
	AddIterator(id *string, props *DescriptionBuilderIteratorProps) DescriptionBuilderIterator
	AddReference(id *string, props *AddReferenceProps) awsstepfunctions.IChainable
	AddSection(id *string, props *DescriptionBuilderSectionProps) DescriptionBuilderSection
	BuildId(prefix *string, id *string) *string
	Initialize() awsstepfunctions.IChainable
	RegisterBuilder(builder IDescriptionBuilderComponent) IDescriptionBuilderComponent
	RegisterChainable(chainable awsstepfunctions.IChainable) awsstepfunctions.IChainable
	Render() awsstepfunctions.IChainable
	SetDelimiter(id *string, props *SetDelimiterProps) awsstepfunctions.IChainable
	// Returns a string representation of this construct.
	ToString() *string
	Write(id *string, props *WriteProps) awsstepfunctions.IChainable
}

func NewDescriptionBuilder 

func NewDescriptionBuilder(scope constructs.IConstruct, props *DescriptionBuilderProps) DescriptionBuilder

type DescriptionBuilderIterator 

type DescriptionBuilderIterator interface {
	constructs.Construct
	IDelayedChainable
	IDescriptionBuilderComponent
	ArrayRef() *string
	Classifier() *string
	FieldDelimiter() AppendDelimiter
	// The tree node.
	Node() constructs.Node
	RecordDelimiter() AppendDelimiter
	ResultPath() *string
	SectionDelimiter() AppendDelimiter
	Title() *string
	AddIterator(id *string, props *DescriptionBuilderIteratorProps) DescriptionBuilderIterator
	AddReference(id *string, props *AddReferenceProps) awsstepfunctions.IChainable
	BuildId(prefix *string, id *string) *string
	RegisterBuilder(builder IDescriptionBuilderComponent) IDescriptionBuilderComponent
	RegisterChainable(chainable awsstepfunctions.IChainable) awsstepfunctions.IChainable
	Render() awsstepfunctions.IChainable
	SetDelimiter(id *string, props *SetDelimiterProps) awsstepfunctions.IChainable
	// Returns a string representation of this construct.
	ToString() *string
	Write(id *string, props *WriteProps) awsstepfunctions.IChainable
}

func NewDescriptionBuilderIterator 

func NewDescriptionBuilderIterator(scope constructs.IConstruct, id *string, props *DescriptionBuilderIteratorProps) DescriptionBuilderIterator

type DescriptionBuilderIteratorProps 

type DescriptionBuilderIteratorProps struct {
	ArrayRef         *string         `field:"required" json:"arrayRef" yaml:"arrayRef"`
	ResultPath       *string         `field:"required" json:"resultPath" yaml:"resultPath"`
	FieldDelimiter   AppendDelimiter `field:"optional" json:"fieldDelimiter" yaml:"fieldDelimiter"`
	RecordDelimiter  AppendDelimiter `field:"optional" json:"recordDelimiter" yaml:"recordDelimiter"`
	SectionDelimiter AppendDelimiter `field:"optional" json:"sectionDelimiter" yaml:"sectionDelimiter"`
	Title            *string         `field:"optional" json:"title" yaml:"title"`
}

type DescriptionBuilderProps 

type DescriptionBuilderProps struct {
	InitialDescription *string `field:"optional" json:"initialDescription" yaml:"initialDescription"`
}

type DescriptionBuilderSection 

type DescriptionBuilderSection interface {
	constructs.Construct
	IDelayedChainable
	IDescriptionBuilderComponent
	Classifier() *string
	// The tree node.
	Node() constructs.Node
	Refs() *[]*string
	Title() *string
	AddIterator(id *string, props *DescriptionBuilderIteratorProps) DescriptionBuilderIterator
	AddReference(id *string, props *AddReferenceProps) awsstepfunctions.IChainable
	AddReferenceCheck(ref *string)
	BuildId(prefix *string, id *string) *string
	RegisterBuilder(builder IDescriptionBuilderComponent) IDescriptionBuilderComponent
	RegisterChainable(chainable awsstepfunctions.IChainable) awsstepfunctions.IChainable
	Render() awsstepfunctions.IChainable
	SetDelimiter(id *string, props *SetDelimiterProps) awsstepfunctions.IChainable
	// Returns a string representation of this construct.
	ToString() *string
	Write(id *string, props *WriteProps) awsstepfunctions.IChainable
}

func NewDescriptionBuilderSection 

func NewDescriptionBuilderSection(scope constructs.IConstruct, id *string, props *DescriptionBuilderSectionProps) DescriptionBuilderSection

type DescriptionBuilderSectionProps 

type DescriptionBuilderSectionProps struct {
	Title           *string    `field:"required" json:"title" yaml:"title"`
	ReferenceChecks *[]*string `field:"optional" json:"referenceChecks" yaml:"referenceChecks"`
}

type Discord added in v0.0.82 

type Discord interface {
	IssuePluginBase
	IIssueHandler
	// Destination pointing to a Jira instance where tickets are to be created.
	ApiDestination() awsevents.ApiDestination
	// The default Discord channel where messages processed by the handler should be sent if no override is given.
	Channel() *string
	// API connection providing details of how to communicate with the configured Jira instance.
	Connection() awsevents.Connection
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	// The event bus to use to trigger writes to the Jira instance.
	//
	// This integration formats a Jira API response and then sends it to a Jira
	// instance by means of an EventBridge Destination API and a specially
	// crafted event pattern. This is the event bus where the rule to trigger the
	// API will be added and the trigger event will be sent.
	EventBus() awsevents.IEventBus
	// The State Machine that handles creating a Jira ticket for a passed issue.
	//
	// Internally this state machine uses the AWS managed `AWS-CreateJiraIssue`
	// SSM Automation document.
	Handler() awsstepfunctions.IStateMachine
	Logging() *StateMachineLogging
	// Collection of users or roles who should be mentioned by default when sending a message to Discord.
	Mentions() *[]*string
	// The human friendly name that can be used to identify the plugin.
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	// The length of time that the State Machine that handles creation of Jira tickets is allowed to run before timing out.
	Timeout() awscdk.Duration
	// The token for a Discord bot that has permissions to post in the destination channels.
	//
	// The secret should be in JSON format and contain the
	// key:
	//
	// token: The token for the bot that has permissions to post in the
	// destination Discord channels.
	Token() awssecretsmanager.ISecret
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	BuildEventOverrides(options *DiscordOverrideOptions) IssueHandlerOverride
	BuildLogging() *awsstepfunctions.LogOptions
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	ToString() *string
}

A standardized implementation that allows Discord messages to be sent in response to events detected in AWS.

Intended for use with the `IssueManager` state machine which allows arbitrary types of events to be processed into standard values and then output or one of more issue tracking services.

func IssueHander_Discord added in v0.0.82 

func IssueHander_Discord(scope constructs.IConstruct, id *string, props *DiscordProps) Discord

func NewDiscord added in v0.0.82 

func NewDiscord(scope constructs.IConstruct, id *string, props *DiscordProps) Discord

Creates a new instance of the JiraTicket class.

type DiscordOverrideOptions added in v0.0.82 

type DiscordOverrideOptions struct {
	Channel  *string    `field:"optional" json:"channel" yaml:"channel"`
	Mentions *[]*string `field:"optional" json:"mentions" yaml:"mentions"`
}

type DiscordProps added in v0.0.82 

type DiscordProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region   *string                   `field:"optional" json:"region" yaml:"region"`
	Logging  *StateMachineLogging      `field:"optional" json:"logging" yaml:"logging"`
	Channel  *string                   `field:"required" json:"channel" yaml:"channel"`
	Token    awssecretsmanager.ISecret `field:"required" json:"token" yaml:"token"`
	EventBus awsevents.IEventBus       `field:"optional" json:"eventBus" yaml:"eventBus"`
	Mentions *[]*string                `field:"optional" json:"mentions" yaml:"mentions"`
	Name     *string                   `field:"optional" json:"name" yaml:"name"`
	Timeout  awscdk.Duration           `field:"optional" json:"timeout" yaml:"timeout"`
}

Configuration controlling how Discord messages should be sent in response to events.

type EcrImageScanSeverity 

type EcrImageScanSeverity interface {
	Name() *string
	Priority() *float64
	Standardized() *string
}

func EcrImageScanSeverity_CRITICAL 

func EcrImageScanSeverity_CRITICAL() EcrImageScanSeverity

func EcrImageScanSeverity_HIGH 

func EcrImageScanSeverity_HIGH() EcrImageScanSeverity

func EcrImageScanSeverity_LOW 

func EcrImageScanSeverity_LOW() EcrImageScanSeverity

func EcrImageScanSeverity_MEDIUM 

func EcrImageScanSeverity_MEDIUM() EcrImageScanSeverity

func EcrImageScanSeverity_Of 

func EcrImageScanSeverity_Of(name *string, priority *float64, standardized *string) EcrImageScanSeverity

func EcrImageScanSeverity_UNDEFINED 

func EcrImageScanSeverity_UNDEFINED() EcrImageScanSeverity

type EcrImageScanSeverityConfiguration 

type EcrImageScanSeverityConfiguration interface {
}

func NewEcrImageScanSeverityConfiguration 

func NewEcrImageScanSeverityConfiguration() EcrImageScanSeverityConfiguration

type EcrScanFinding 

type EcrScanFinding interface {
	IssuePluginBase
	IIssueParser
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	Handler() awsstepfunctions.IStateMachine
	Logging() *StateMachineLogging
	MatchType() *string
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	Timeout() awscdk.Duration
	Triggers() *[]IssueTrigger
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Bind(_scope constructs.IConstruct) *[]IssueTrigger
	BuildDescription() *string
	BuildLogging() *awsstepfunctions.LogOptions
	BuildSummary() *string
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	RegisterIssueTrigger(id *string, options *EcrScanFindingEventOptions) IssueTrigger
	// Returns a string representation of this construct.
	ToString() *string
}

func IssueParser_EcrScanFinding added in v0.0.80 

func IssueParser_EcrScanFinding(scope constructs.IConstruct, id *string, props *EcrScanFindingProps) EcrScanFinding

func NewEcrScanFinding 

func NewEcrScanFinding(scope constructs.IConstruct, id *string, props *EcrScanFindingProps) EcrScanFinding

type EcrScanFindingEventOptions 

type EcrScanFindingEventOptions struct {
	Overrides *[]IssueHandlerOverride            `field:"optional" json:"overrides" yaml:"overrides"`
	Severity  IEcrImageScanSeverityConfiguration `field:"optional" json:"severity" yaml:"severity"`
}

type EcrScanFindingProps 

type EcrScanFindingProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region    *string              `field:"optional" json:"region" yaml:"region"`
	Logging   *StateMachineLogging `field:"optional" json:"logging" yaml:"logging"`
	MatchType *string              `field:"optional" json:"matchType" yaml:"matchType"`
	Name      *string              `field:"optional" json:"name" yaml:"name"`
	Timeout   awscdk.Duration      `field:"optional" json:"timeout" yaml:"timeout"`
}

type GuardDutyFinding 

type GuardDutyFinding interface {
	IssueParserPluginBase
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	Handler() awsstepfunctions.IStateMachine
	Logging() *StateMachineLogging
	MatchType() *string
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	Timeout() awscdk.Duration
	Triggers() *[]IssueTrigger
	AddDefaultTrigger() IssueTrigger
	AddSectionField(id *string, key *string, path *string) awsstepfunctions.Chain
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Bind(_scope constructs.IConstruct) *[]IssueTrigger
	BuildLogging() *awsstepfunctions.LogOptions
	BuildSeverityMap() awsstepfunctions.Chain
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	RegisterIssueTrigger(id *string, options *GuardDutyFindingRuleOptions) IssueTrigger
	// Returns a string representation of this construct.
	ToString() *string
}

func IssueParser_GuardDutyFinding added in v0.0.80 

func IssueParser_GuardDutyFinding(scope constructs.IConstruct, id *string, props *GuardDutyFindingProps) GuardDutyFinding

func NewGuardDutyFinding 

func NewGuardDutyFinding(scope constructs.IConstruct, id *string, props *GuardDutyFindingProps) GuardDutyFinding

type GuardDutyFindingProps 

type GuardDutyFindingProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region  *string              `field:"optional" json:"region" yaml:"region"`
	Logging *StateMachineLogging `field:"optional" json:"logging" yaml:"logging"`
}

type GuardDutyFindingRuleOptions 

type GuardDutyFindingRuleOptions struct {
	Overrides *[]IssueHandlerOverride `field:"optional" json:"overrides" yaml:"overrides"`
	Severity  *[]GuardDutySeverity    `field:"optional" json:"severity" yaml:"severity"`
}

type GuardDutySeverity 

type GuardDutySeverity interface {
	LowerBound() *float64
	Standardized() *string
	UpperBound() *float64
	BuildCondition(path *string) awsstepfunctions.Condition
}

func GuardDutySeverity_CRITICAL 

func GuardDutySeverity_CRITICAL() GuardDutySeverity

func GuardDutySeverity_HIGH 

func GuardDutySeverity_HIGH() GuardDutySeverity

func GuardDutySeverity_INFORMATIONAL 

func GuardDutySeverity_INFORMATIONAL() GuardDutySeverity

func GuardDutySeverity_LOW 

func GuardDutySeverity_LOW() GuardDutySeverity

func GuardDutySeverity_MEDIUM 

func GuardDutySeverity_MEDIUM() GuardDutySeverity

func GuardDutySeverity_Of 

func GuardDutySeverity_Of(standardized *string, lowerBound *float64, upperBound *float64) GuardDutySeverity

type IDelayedChainable 

type IDelayedChainable interface {
	Render() awsstepfunctions.IChainable
}

type IDescriptionBuilderComponent 

type IDescriptionBuilderComponent interface {
	IDelayedChainable
	AddIterator(id *string, props *DescriptionBuilderIteratorProps) DescriptionBuilderIterator
	AddReference(id *string, props *AddReferenceProps) awsstepfunctions.IChainable
	SetDelimiter(id *string, props *SetDelimiterProps) awsstepfunctions.IChainable
	Write(id *string, props *WriteProps) awsstepfunctions.IChainable
	Classifier() *string
}

type IEcrImageScanSeverityConfiguration 

type IEcrImageScanSeverityConfiguration interface {
	Levels() *[]EcrImageScanSeverity
}

func EcrImageScanSeverityConfiguration_All 

func EcrImageScanSeverityConfiguration_All() IEcrImageScanSeverityConfiguration

func EcrImageScanSeverityConfiguration_Custom 

func EcrImageScanSeverityConfiguration_Custom(levels ...EcrImageScanSeverity) IEcrImageScanSeverityConfiguration

func EcrImageScanSeverityConfiguration_Threshold 

func EcrImageScanSeverityConfiguration_Threshold(level EcrImageScanSeverity) IEcrImageScanSeverityConfiguration

type IIssueHandler 

type IIssueHandler interface {
	awscdk.IResource
	Handler() awsstepfunctions.IStateMachine
	Name() *string
}

type IIssueParser 

type IIssueParser interface {
	awscdk.IResource
	Bind(node constructs.IConstruct) *[]IssueTrigger
	Handler() awsstepfunctions.IStateMachine
	MatchType() *string
}

type ISecurityHubSeverityConfiguration 

type ISecurityHubSeverityConfiguration interface {
	Levels() *[]SecurityHubSeverity
}

func SecurityHubSeverityConfiguration_All 

func SecurityHubSeverityConfiguration_All() ISecurityHubSeverityConfiguration

func SecurityHubSeverityConfiguration_Custom 

func SecurityHubSeverityConfiguration_Custom(levels ...SecurityHubSeverity) ISecurityHubSeverityConfiguration

func SecurityHubSeverityConfiguration_Threshold 

func SecurityHubSeverityConfiguration_Threshold(level SecurityHubSeverity) ISecurityHubSeverityConfiguration

type InspectorFinding 

type InspectorFinding interface {
	IssueParserPluginBase
	IIssueParser
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	Handler() awsstepfunctions.IStateMachine
	Logging() *StateMachineLogging
	MatchType() *string
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	Timeout() awscdk.Duration
	Triggers() *[]IssueTrigger
	AddDefaultTrigger() IssueTrigger
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Bind(_node constructs.IConstruct) *[]IssueTrigger
	BuildDescription() DescriptionBuilder
	BuildLogging() *awsstepfunctions.LogOptions
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	RegisterIssueTrigger(id *string, options *InspectorFindingEventOptions) IssueTrigger
	// Returns a string representation of this construct.
	ToString() *string
}

func IssueParser_InspectorFinding added in v0.0.80 

func IssueParser_InspectorFinding(scope constructs.IConstruct, id *string, props *InspectorFindingProps) InspectorFinding

func NewInspectorFinding 

func NewInspectorFinding(scope constructs.IConstruct, id *string, props *InspectorFindingProps) InspectorFinding

type InspectorFindingEventOptions 

type InspectorFindingEventOptions struct {
	Overrides *[]IssueHandlerOverride `field:"optional" json:"overrides" yaml:"overrides"`
	Severity  *[]InspectorSeverity    `field:"optional" json:"severity" yaml:"severity"`
}

type InspectorFindingProps 

type InspectorFindingProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region    *string              `field:"optional" json:"region" yaml:"region"`
	Logging   *StateMachineLogging `field:"optional" json:"logging" yaml:"logging"`
	MatchType *string              `field:"optional" json:"matchType" yaml:"matchType"`
	Name      *string              `field:"optional" json:"name" yaml:"name"`
	Timeout   awscdk.Duration      `field:"optional" json:"timeout" yaml:"timeout"`
}

type InspectorSeverity 

type InspectorSeverity interface {
	Original() *string
	Priority() *float64
	Standardized() *string
	BuildCondition(path *string) awsstepfunctions.Condition
}

func InspectorSeverity_CRITICAL 

func InspectorSeverity_CRITICAL() InspectorSeverity

func InspectorSeverity_HIGH 

func InspectorSeverity_HIGH() InspectorSeverity

func InspectorSeverity_INFORMATIONAL 

func InspectorSeverity_INFORMATIONAL() InspectorSeverity

func InspectorSeverity_LOW 

func InspectorSeverity_LOW() InspectorSeverity

func InspectorSeverity_MEDIUM 

func InspectorSeverity_MEDIUM() InspectorSeverity

func InspectorSeverity_Of 

func InspectorSeverity_Of(standardized *string, original *string, priority *float64) InspectorSeverity

func InspectorSeverity_UNTRIAGED 

func InspectorSeverity_UNTRIAGED() InspectorSeverity

type IssueHander 

type IssueHander interface {
}

func NewIssueHander 

func NewIssueHander() IssueHander

type IssueHandlerOverride 

type IssueHandlerOverride interface {
	Handler() IIssueHandler
	Overrides() *map[string]interface{}
}

func NewIssueHandlerOverride 

func NewIssueHandlerOverride(handler IIssueHandler, overrides *map[string]interface{}) IssueHandlerOverride

type IssueManager 

type IssueManager interface {
	awscdk.Resource
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	Timeout() awscdk.Duration
	AddEventRules(stateMachine awsstepfunctions.StateMachine)
	// Adds a destination that handles issues that get passed to the issue manager.
	AddHandler(handler IIssueHandler)
	// Adds a parser that is used to transform incoming issues into a known format that can be passed to the destinations where they will be consumed by users.
	AddIssueParser(parser IIssueParser)
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	ToString() *string
}

func NewIssueManager 

func NewIssueManager(scope constructs.IConstruct, id *string, props *IssueManagerProps) IssueManager

type IssueManagerProps 

type IssueManagerProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region   *string          `field:"optional" json:"region" yaml:"region"`
	Handlers *[]IIssueHandler `field:"optional" json:"handlers" yaml:"handlers"`
	Name     *string          `field:"optional" json:"name" yaml:"name"`
	Parsers  *[]IIssueParser  `field:"optional" json:"parsers" yaml:"parsers"`
	Timeout  awscdk.Duration  `field:"optional" json:"timeout" yaml:"timeout"`
}

type IssueParser added in v0.0.80 

type IssueParser interface {
}

func NewIssueParser added in v0.0.80 

func NewIssueParser() IssueParser

type IssueParserPluginBase 

type IssueParserPluginBase interface {
	IssuePluginBase
	IIssueParser
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	Handler() awsstepfunctions.IStateMachine
	Logging() *StateMachineLogging
	MatchType() *string
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	Timeout() awscdk.Duration
	Triggers() *[]IssueTrigger
	AddDefaultTrigger() IssueTrigger
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Bind(_node constructs.IConstruct) *[]IssueTrigger
	BuildLogging() *awsstepfunctions.LogOptions
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	ToString() *string
}

type IssueParserPluginBaseProps 

type IssueParserPluginBaseProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region    *string              `field:"optional" json:"region" yaml:"region"`
	Logging   *StateMachineLogging `field:"optional" json:"logging" yaml:"logging"`
	MatchType *string              `field:"optional" json:"matchType" yaml:"matchType"`
	Name      *string              `field:"optional" json:"name" yaml:"name"`
	Timeout   awscdk.Duration      `field:"optional" json:"timeout" yaml:"timeout"`
}

type IssuePluginBase 

type IssuePluginBase interface {
	awscdk.Resource
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	Logging() *StateMachineLogging
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	BuildLogging() *awsstepfunctions.LogOptions
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	ToString() *string
}

type IssuePluginBaseProps 

type IssuePluginBaseProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region  *string              `field:"optional" json:"region" yaml:"region"`
	Logging *StateMachineLogging `field:"optional" json:"logging" yaml:"logging"`
}

type IssueTrigger 

type IssueTrigger interface {
	constructs.Construct
	EventPattern() *awsevents.EventPattern
	// The tree node.
	Node() constructs.Node
	Overrides() *[]IssueHandlerOverride
	Parser() IIssueParser
	AddOverride(handlerOverrides IssueHandlerOverride)
	Bind(stateMachine awsstepfunctions.StateMachine) awsevents.Rule
	// Returns a string representation of this construct.
	ToString() *string
}

func NewIssueTrigger 

func NewIssueTrigger(scope constructs.IConstruct, id *string, props *IssueTriggerProps) IssueTrigger

type IssueTriggerProps 

type IssueTriggerProps struct {
	EventPattern *awsevents.EventPattern `field:"required" json:"eventPattern" yaml:"eventPattern"`
	Parser       IIssueParser            `field:"required" json:"parser" yaml:"parser"`
	Overrides    *[]IssueHandlerOverride `field:"optional" json:"overrides" yaml:"overrides"`
}

type JiraTicket 

type JiraTicket interface {
	IssuePluginBase
	IIssueHandler
	// Destination pointing to a Jira instance where tickets are to be created.
	ApiDestination() awsevents.ApiDestination
	// The default assignee that issues should be created with if no other assignee is specified by the event that triggered the issue creation.
	Assignee() *string
	// API connection providing details of how to communicate with the configured Jira instance.
	Connection() awsevents.Connection
	// The credentials to be used for connecting to Jira. The secret should be in JSON format and contain the key:.
	//
	// username: The name of the user issues should be created as.
	// password: A password or API key for the user specified in `username`.
	Credentials() awssecretsmanager.ISecret
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	// The event bus to use to trigger writes to the Jira instance.
	//
	// This integration formats a Jira API response and then sends it to a Jira
	// instance by means of an EventBridge Destination API and a specially
	// crafted event pattern. This is the event bus where the rule to trigger the
	// API will be added and the trigger event will be sent.
	EventBus() awsevents.IEventBus
	// The State Machine that handles creating a Jira ticket for a passed issue.
	//
	// Internally this state machine uses the AWS managed `AWS-CreateJiraIssue`
	// SSM Automation document.
	Handler() awsstepfunctions.IStateMachine
	// The default issue type that issues should be created as if no other type is specified by the event that triggered the issue creation.
	IssueType() *string
	// The URL of the Jira instance where tickets should be created.
	JiraUrl() *string
	Logging() *StateMachineLogging
	// The human friendly name that can be used to identify the plugin.
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// A mapping of the standard severities supported by issue manager to priority levels supported by the destination Jira instance.
	PriorityMap() *JiraTicketPriorityMap
	// The name of the default project to use for creating issues if no other project is specified by the event that triggered the issue creation.
	Project() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	// The length of time that the State Machine that handles creation of Jira tickets is allowed to run before timing out.
	Timeout() awscdk.Duration
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	BuildEventOverrides(options *JiraTicketOverrideOptions) IssueHandlerOverride
	BuildLogging() *awsstepfunctions.LogOptions
	BuildSeverityMap() awsstepfunctions.Chain
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	ToString() *string
}

A standardized implementation that allows Jira tickets to be created in response to events detected in AWS.

Intended for use with the `IssueManager` state machine which allows arbitrary types of events to be processed into standard values and then output or one of more issue tracking services. See: [AWS-CreateJiraIssue](https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-aws-createjiraissue.html)

func IssueHander_JiraTicket 

func IssueHander_JiraTicket(scope constructs.IConstruct, id *string, props *JiraTicketProps) JiraTicket

func NewJiraTicket 

func NewJiraTicket(scope constructs.IConstruct, id *string, props *JiraTicketProps) JiraTicket

Creates a new instance of the JiraTicket class.

type JiraTicketOverrideOptions 

type JiraTicketOverrideOptions struct {
	Assignee      *string `field:"optional" json:"assignee" yaml:"assignee"`
	IssuePriority *string `field:"optional" json:"issuePriority" yaml:"issuePriority"`
	IssueType     *string `field:"optional" json:"issueType" yaml:"issueType"`
	Project       *string `field:"optional" json:"project" yaml:"project"`
}

type JiraTicketPriorityMap 

type JiraTicketPriorityMap struct {
	Critical *string `field:"optional" json:"critical" yaml:"critical"`
	Default  *string `field:"optional" json:"default" yaml:"default"`
	High     *string `field:"optional" json:"high" yaml:"high"`
	Info     *string `field:"optional" json:"info" yaml:"info"`
	Low      *string `field:"optional" json:"low" yaml:"low"`
	Medium   *string `field:"optional" json:"medium" yaml:"medium"`
}

type JiraTicketProps 

type JiraTicketProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region      *string                   `field:"optional" json:"region" yaml:"region"`
	Logging     *StateMachineLogging      `field:"optional" json:"logging" yaml:"logging"`
	Credentials awssecretsmanager.ISecret `field:"required" json:"credentials" yaml:"credentials"`
	IssueType   *string                   `field:"required" json:"issueType" yaml:"issueType"`
	JiraUrl     *string                   `field:"required" json:"jiraUrl" yaml:"jiraUrl"`
	PriorityMap *JiraTicketPriorityMap    `field:"required" json:"priorityMap" yaml:"priorityMap"`
	Project     *string                   `field:"required" json:"project" yaml:"project"`
	Assignee    *string                   `field:"optional" json:"assignee" yaml:"assignee"`
	EventBus    awsevents.IEventBus       `field:"optional" json:"eventBus" yaml:"eventBus"`
	Name        *string                   `field:"optional" json:"name" yaml:"name"`
	Timeout     awscdk.Duration           `field:"optional" json:"timeout" yaml:"timeout"`
}

Configuration controlling how Jira tickets should be created in response to events.

type OpenSearchEvent 

type OpenSearchEvent interface {
	IssueParserPluginBase
	IIssueParser
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	Handler() awsstepfunctions.IStateMachine
	Logging() *StateMachineLogging
	MatchType() *string
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	Timeout() awscdk.Duration
	Triggers() *[]IssueTrigger
	AddDefaultTrigger() IssueTrigger
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Bind(_node constructs.IConstruct) *[]IssueTrigger
	BuildDescription() DescriptionBuilder
	BuildLogging() *awsstepfunctions.LogOptions
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	RegisterIssueTrigger(id *string, options *OpenSearchEventRuleOptions) IssueTrigger
	// Returns a string representation of this construct.
	ToString() *string
}

func IssueParser_OpenSearchEvent added in v0.0.80 

func IssueParser_OpenSearchEvent(scope constructs.IConstruct, id *string, props *OpenSearchEventProps) OpenSearchEvent

func NewOpenSearchEvent 

func NewOpenSearchEvent(scope constructs.IConstruct, id *string, props *OpenSearchEventProps) OpenSearchEvent

type OpenSearchEventProps 

type OpenSearchEventProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region    *string              `field:"optional" json:"region" yaml:"region"`
	Logging   *StateMachineLogging `field:"optional" json:"logging" yaml:"logging"`
	MatchType *string              `field:"optional" json:"matchType" yaml:"matchType"`
	Name      *string              `field:"optional" json:"name" yaml:"name"`
	Timeout   awscdk.Duration      `field:"optional" json:"timeout" yaml:"timeout"`
}

type OpenSearchEventRuleOptions 

type OpenSearchEventRuleOptions struct {
	Overrides *[]IssueHandlerOverride    `field:"optional" json:"overrides" yaml:"overrides"`
	Severity  *[]OpenSearchEventSeverity `field:"optional" json:"severity" yaml:"severity"`
	Types     *[]OpenSearchEventType     `field:"optional" json:"types" yaml:"types"`
}

type OpenSearchEventSeverity 

type OpenSearchEventSeverity interface {
	Original() *string
	Priority() *float64
	Standardized() *string
	BuildCondition(path *string) awsstepfunctions.Condition
}

func OpenSearchEventSeverity_HIGH 

func OpenSearchEventSeverity_HIGH() OpenSearchEventSeverity

func OpenSearchEventSeverity_INFORMATIONAL 

func OpenSearchEventSeverity_INFORMATIONAL() OpenSearchEventSeverity

func OpenSearchEventSeverity_LOW 

func OpenSearchEventSeverity_LOW() OpenSearchEventSeverity

func OpenSearchEventSeverity_MEDIUM 

func OpenSearchEventSeverity_MEDIUM() OpenSearchEventSeverity

func OpenSearchEventSeverity_Of 

func OpenSearchEventSeverity_Of(standardized *string, original *string, priority *float64) OpenSearchEventSeverity

type OpenSearchEventType 

type OpenSearchEventType interface {
	DetailType() *string
	EventName() *string
}

Represents a type of event that can be generated in response to circumstances happening on an AWS OpenSearch service cluster. See: [Monitoring OpenSearch Service events with Amazon EventBridge](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-events.html)

func OpenSearchEventType_AUTO_TUNE 

func OpenSearchEventType_AUTO_TUNE() OpenSearchEventType

func OpenSearchEventType_CLUSTER_RECOVERY 

func OpenSearchEventType_CLUSTER_RECOVERY() OpenSearchEventType

func OpenSearchEventType_CUSTOM_INDEX_ROUTING 

func OpenSearchEventType_CUSTOM_INDEX_ROUTING() OpenSearchEventType

func OpenSearchEventType_DISK_THROUGHPUT_THROTTLE 

func OpenSearchEventType_DISK_THROUGHPUT_THROTTLE() OpenSearchEventType

func OpenSearchEventType_DOMAIN_UPDATE 

func OpenSearchEventType_DOMAIN_UPDATE() OpenSearchEventType

func OpenSearchEventType_EBS_BURST_BALANCE 

func OpenSearchEventType_EBS_BURST_BALANCE() OpenSearchEventType

func OpenSearchEventType_FAILED_SHARD_LOCK 

func OpenSearchEventType_FAILED_SHARD_LOCK() OpenSearchEventType

func OpenSearchEventType_HIGH_JVM_USAGE 

func OpenSearchEventType_HIGH_JVM_USAGE() OpenSearchEventType

func OpenSearchEventType_HIGH_SHARED_COUNT 

func OpenSearchEventType_HIGH_SHARED_COUNT() OpenSearchEventType

func OpenSearchEventType_INSUFFICIENT_GARBAGE_COLLECTION 

func OpenSearchEventType_INSUFFICIENT_GARBAGE_COLLECTION() OpenSearchEventType

func OpenSearchEventType_KMS_KEY_INACCESSIBLE 

func OpenSearchEventType_KMS_KEY_INACCESSIBLE() OpenSearchEventType

func OpenSearchEventType_LARGE_SHARD_SIZE 

func OpenSearchEventType_LARGE_SHARD_SIZE() OpenSearchEventType

func OpenSearchEventType_LOW_DISK_SPACE 

func OpenSearchEventType_LOW_DISK_SPACE() OpenSearchEventType

func OpenSearchEventType_LOW_DISK_WATERMARK_BREACH 

func OpenSearchEventType_LOW_DISK_WATERMARK_BREACH() OpenSearchEventType

func OpenSearchEventType_NODE_RETIREMENT 

func OpenSearchEventType_NODE_RETIREMENT() OpenSearchEventType

func OpenSearchEventType_Of 

func OpenSearchEventType_Of(props *OpenSearchEventTypeProps) OpenSearchEventType

func OpenSearchEventType_SERVICE_SOFTWARE_UPDATE 

func OpenSearchEventType_SERVICE_SOFTWARE_UPDATE() OpenSearchEventType

func OpenSearchEventType_VPC_ENDPOINT_CREATE 

func OpenSearchEventType_VPC_ENDPOINT_CREATE() OpenSearchEventType

func OpenSearchEventType_VPC_ENDPOINT_DELETE 

func OpenSearchEventType_VPC_ENDPOINT_DELETE() OpenSearchEventType

func OpenSearchEventType_VPC_ENDPOINT_UPDATE 

func OpenSearchEventType_VPC_ENDPOINT_UPDATE() OpenSearchEventType

type OpenSearchEventTypeProps 

type OpenSearchEventTypeProps struct {
	DetailType *string `field:"required" json:"detailType" yaml:"detailType"`
	EventName  *string `field:"required" json:"eventName" yaml:"eventName"`
}

type SecurityHubFinding 

type SecurityHubFinding interface {
	IssuePluginBase
	IIssueParser
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	Handler() awsstepfunctions.IStateMachine
	Logging() *StateMachineLogging
	MatchType() *string
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	Timeout() awscdk.Duration
	Triggers() *[]IssueTrigger
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Bind(_scope constructs.IConstruct) *[]IssueTrigger
	BuildDescription() awsstepfunctions.Chain
	BuildLogging() *awsstepfunctions.LogOptions
	BuildRemediation() awsstepfunctions.Chain
	BuildResources() awsstepfunctions.Chain
	BuildSeverityMap() awsstepfunctions.Chain
	BuildUrl() awsstepfunctions.Chain
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	RegisterIssueTrigger(id *string, options *SecurityHubFindingEventOptions) IssueTrigger
	// Returns a string representation of this construct.
	ToString() *string
}

func IssueParser_SecurityHubFinding added in v0.0.80 

func IssueParser_SecurityHubFinding(scope constructs.IConstruct, id *string, props *SecurityHubFindingProps) SecurityHubFinding

func NewSecurityHubFinding 

func NewSecurityHubFinding(scope constructs.IConstruct, id *string, props *SecurityHubFindingProps) SecurityHubFinding

type SecurityHubFindingEventOptions 

type SecurityHubFindingEventOptions struct {
	Overrides *[]IssueHandlerOverride           `field:"optional" json:"overrides" yaml:"overrides"`
	Severity  ISecurityHubSeverityConfiguration `field:"optional" json:"severity" yaml:"severity"`
}

type SecurityHubFindingProps 

type SecurityHubFindingProps struct {
	// The AWS account ID this resource belongs to.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	Region    *string              `field:"optional" json:"region" yaml:"region"`
	Logging   *StateMachineLogging `field:"optional" json:"logging" yaml:"logging"`
	MatchType *string              `field:"optional" json:"matchType" yaml:"matchType"`
	Name      *string              `field:"optional" json:"name" yaml:"name"`
	Timeout   awscdk.Duration      `field:"optional" json:"timeout" yaml:"timeout"`
}

type SecurityHubSeverity 

type SecurityHubSeverity interface {
	LowerBound() *float64
	Name() *string
	Standardized() *string
	UpperBound() *float64
}

func SecurityHubSeverity_CRITICAL 

func SecurityHubSeverity_CRITICAL() SecurityHubSeverity

func SecurityHubSeverity_HIGH 

func SecurityHubSeverity_HIGH() SecurityHubSeverity

func SecurityHubSeverity_INFORMATIONAL 

func SecurityHubSeverity_INFORMATIONAL() SecurityHubSeverity

func SecurityHubSeverity_LOW 

func SecurityHubSeverity_LOW() SecurityHubSeverity

func SecurityHubSeverity_MEDIUM 

func SecurityHubSeverity_MEDIUM() SecurityHubSeverity

func SecurityHubSeverity_Of 

func SecurityHubSeverity_Of(name *string, lowerBound *float64, upperBound *float64, standardized *string) SecurityHubSeverity

type SecurityHubSeverityConfiguration 

type SecurityHubSeverityConfiguration interface {
}

func NewSecurityHubSeverityConfiguration 

func NewSecurityHubSeverityConfiguration() SecurityHubSeverityConfiguration

type SetDelimiterProps 

type SetDelimiterProps struct {
	Delimiter AppendDelimiter `field:"required" json:"delimiter" yaml:"delimiter"`
}

type StateMachineLogging 

type StateMachineLogging struct {
	Destination          awslogs.ILogGroup         `field:"optional" json:"destination" yaml:"destination"`
	Enabled              *bool                     `field:"optional" json:"enabled" yaml:"enabled"`
	IncludeExecutionData *bool                     `field:"optional" json:"includeExecutionData" yaml:"includeExecutionData"`
	Level                awsstepfunctions.LogLevel `field:"optional" json:"level" yaml:"level"`
}

type WriteProps 

type WriteProps struct {
	Value            *string         `field:"required" json:"value" yaml:"value"`
	DefaultDelimiter AppendDelimiter `field:"optional" json:"defaultDelimiter" yaml:"defaultDelimiter"`
	Delimiter        AppendDelimiter `field:"optional" json:"delimiter" yaml:"delimiter"`
	Prefix           *string         `field:"optional" json:"prefix" yaml:"prefix"`
	Required         *bool           `field:"optional" json:"required" yaml:"required"`
	Suffix           *string         `field:"optional" json:"suffix" yaml:"suffix"`
}

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.