awscodestarnotifications

package
v2.0.0 Latest Latest
Warning

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

 Go to latest Published: Dec 2, 2021 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnNotificationRule_CFN_RESOURCE_TYPE_NAME 

func CfnNotificationRule_CFN_RESOURCE_TYPE_NAME() *string

func CfnNotificationRule_IsCfnElement 

func CfnNotificationRule_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.

func CfnNotificationRule_IsCfnResource 

func CfnNotificationRule_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnNotificationRule_IsConstruct 

func CfnNotificationRule_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 NewCfnNotificationRule_Override 

func NewCfnNotificationRule_Override(c CfnNotificationRule, scope constructs.Construct, id *string, props *CfnNotificationRuleProps)

Create a new `AWS::CodeStarNotifications::NotificationRule`.

func NewNotificationRule_Override 

func NewNotificationRule_Override(n NotificationRule, scope constructs.Construct, id *string, props *NotificationRuleProps)

func NotificationRule_IsConstruct 

func NotificationRule_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 NotificationRule_IsResource 

func NotificationRule_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

Types

type CfnNotificationRule 

type CfnNotificationRule interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreatedBy() *string
	SetCreatedBy(val *string)
	CreationStack() *[]*string
	DetailType() *string
	SetDetailType(val *string)
	EventTypeId() *string
	SetEventTypeId(val *string)
	EventTypeIds() *[]*string
	SetEventTypeIds(val *[]*string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Resource() *string
	SetResource(val *string)
	Stack() awscdk.Stack
	Status() *string
	SetStatus(val *string)
	Tags() awscdk.TagManager
	TargetAddress() *string
	SetTargetAddress(val *string)
	Targets() interface{}
	SetTargets(val interface{})
	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)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CodeStarNotifications::NotificationRule`.

TODO: EXAMPLE

func NewCfnNotificationRule 

func NewCfnNotificationRule(scope constructs.Construct, id *string, props *CfnNotificationRuleProps) CfnNotificationRule

Create a new `AWS::CodeStarNotifications::NotificationRule`.

type CfnNotificationRuleProps 

type CfnNotificationRuleProps struct {
	// `AWS::CodeStarNotifications::NotificationRule.CreatedBy`.
	CreatedBy *string `json:"createdBy"`
	// `AWS::CodeStarNotifications::NotificationRule.DetailType`.
	DetailType *string `json:"detailType"`
	// `AWS::CodeStarNotifications::NotificationRule.EventTypeId`.
	EventTypeId *string `json:"eventTypeId"`
	// `AWS::CodeStarNotifications::NotificationRule.EventTypeIds`.
	EventTypeIds *[]*string `json:"eventTypeIds"`
	// `AWS::CodeStarNotifications::NotificationRule.Name`.
	Name *string `json:"name"`
	// `AWS::CodeStarNotifications::NotificationRule.Resource`.
	Resource *string `json:"resource"`
	// `AWS::CodeStarNotifications::NotificationRule.Status`.
	Status *string `json:"status"`
	// `AWS::CodeStarNotifications::NotificationRule.Tags`.
	Tags interface{} `json:"tags"`
	// `AWS::CodeStarNotifications::NotificationRule.TargetAddress`.
	TargetAddress *string `json:"targetAddress"`
	// `AWS::CodeStarNotifications::NotificationRule.Targets`.
	Targets interface{} `json:"targets"`
}

Properties for defining a `AWS::CodeStarNotifications::NotificationRule`.

TODO: EXAMPLE

type CfnNotificationRule_TargetProperty 

type CfnNotificationRule_TargetProperty struct {
	// `CfnNotificationRule.TargetProperty.TargetAddress`.
	TargetAddress *string `json:"targetAddress"`
	// `CfnNotificationRule.TargetProperty.TargetType`.
	TargetType *string `json:"targetType"`
}

TODO: EXAMPLE

type DetailType 

type DetailType string

The level of detail to include in the notifications for this resource. 

const (
	DetailType_BASIC DetailType = "BASIC"
	DetailType_FULL  DetailType = "FULL"
)

type INotificationRule 

type INotificationRule interface {
	awscdk.IResource
	// Adds target to notification rule.
	//
	// Returns: boolean - return true if it had any effect
	AddTarget(target INotificationRuleTarget) *bool
	// The ARN of the notification rule (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde).
	NotificationRuleArn() *string
}

Represents a notification rule.

func NotificationRule_FromNotificationRuleArn 

func NotificationRule_FromNotificationRuleArn(scope constructs.Construct, id *string, notificationRuleArn *string) INotificationRule

Import an existing notification rule provided an ARN.

type INotificationRuleSource 

type INotificationRuleSource interface {
	// Returns a source configuration for notification rule.
	BindAsNotificationRuleSource(scope constructs.Construct) *NotificationRuleSourceConfig
}

Represents a notification source The source that allows CodeBuild and CodePipeline to associate with this rule.

type INotificationRuleTarget 

type INotificationRuleTarget interface {
	// Returns a target configuration for notification rule.
	BindAsNotificationRuleTarget(scope constructs.Construct) *NotificationRuleTargetConfig
}

Represents a notification target That allows AWS Chatbot and SNS topic to associate with this rule target.

type NotificationRule 

type NotificationRule interface {
	awscdk.Resource
	INotificationRule
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	NotificationRuleArn() *string
	PhysicalName() *string
	Stack() awscdk.Stack
	AddTarget(target INotificationRuleTarget) *bool
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

A new notification rule.

TODO: EXAMPLE

func NewNotificationRule 

func NewNotificationRule(scope constructs.Construct, id *string, props *NotificationRuleProps) NotificationRule

type NotificationRuleOptions 

type NotificationRuleOptions struct {
	// The level of detail to include in the notifications for this resource.
	//
	// BASIC will include only the contents of the event as it would appear in AWS CloudWatch.
	// FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
	DetailType DetailType `json:"detailType"`
	// The status of the notification rule.
	//
	// If the enabled is set to DISABLED, notifications aren't sent for the notification rule.
	Enabled *bool `json:"enabled"`
	// The name for the notification rule.
	//
	// Notification rule names must be unique in your AWS account.
	NotificationRuleName *string `json:"notificationRuleName"`
}

Standard set of options for `notifyOnXxx` codestar notification handler on construct.

TODO: EXAMPLE

type NotificationRuleProps 

type NotificationRuleProps struct {
	// The level of detail to include in the notifications for this resource.
	//
	// BASIC will include only the contents of the event as it would appear in AWS CloudWatch.
	// FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
	DetailType DetailType `json:"detailType"`
	// The status of the notification rule.
	//
	// If the enabled is set to DISABLED, notifications aren't sent for the notification rule.
	Enabled *bool `json:"enabled"`
	// The name for the notification rule.
	//
	// Notification rule names must be unique in your AWS account.
	NotificationRuleName *string `json:"notificationRuleName"`
	// A list of event types associated with this notification rule.
	//
	// For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.
	// See: https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api
	//
	Events *[]*string `json:"events"`
	// The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
	//
	// Currently, Supported sources include pipelines in AWS CodePipeline, build projects in AWS CodeBuild, and repositories in AWS CodeCommit in this L2 constructor.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-resource
	//
	Source INotificationRuleSource `json:"source"`
	// The targets to register for the notification destination.
	Targets *[]INotificationRuleTarget `json:"targets"`
}

Properties for a new notification rule.

TODO: EXAMPLE

type NotificationRuleSourceConfig 

type NotificationRuleSourceConfig struct {
	// The Amazon Resource Name (ARN) of the notification source.
	SourceArn *string `json:"sourceArn"`
}

Information about the Codebuild or CodePipeline associated with a notification source.

TODO: EXAMPLE

type NotificationRuleTargetConfig 

type NotificationRuleTargetConfig struct {
	// The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.
	TargetAddress *string `json:"targetAddress"`
	// The target type.
	//
	// Can be an Amazon SNS topic or AWS Chatbot client.
	TargetType *string `json:"targetType"`
}

Information about the SNS topic or AWS Chatbot client associated with a notification target.

TODO: EXAMPLE

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.