awslogs

package
v2.0.0-rc.12 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2021 License: Apache-2.0 Imports: 9 Imported by: 79

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnDestination_CFN_RESOURCE_TYPE_NAME 

func CfnDestination_CFN_RESOURCE_TYPE_NAME() *string

func CfnDestination_IsCfnElement 

func CfnDestination_IsCfnElement(x interface{}) *bool

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

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

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

func CfnDestination_IsCfnResource 

func CfnDestination_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDestination_IsConstruct 

func CfnDestination_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 CfnLogGroup_CFN_RESOURCE_TYPE_NAME 

func CfnLogGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnLogGroup_IsCfnElement 

func CfnLogGroup_IsCfnElement(x interface{}) *bool

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

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

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

func CfnLogGroup_IsCfnResource 

func CfnLogGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnLogGroup_IsConstruct 

func CfnLogGroup_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 CfnLogStream_CFN_RESOURCE_TYPE_NAME 

func CfnLogStream_CFN_RESOURCE_TYPE_NAME() *string

func CfnLogStream_IsCfnElement 

func CfnLogStream_IsCfnElement(x interface{}) *bool

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

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

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

func CfnLogStream_IsCfnResource 

func CfnLogStream_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnLogStream_IsConstruct 

func CfnLogStream_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 CfnMetricFilter_CFN_RESOURCE_TYPE_NAME 

func CfnMetricFilter_CFN_RESOURCE_TYPE_NAME() *string

func CfnMetricFilter_IsCfnElement 

func CfnMetricFilter_IsCfnElement(x interface{}) *bool

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

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

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

func CfnMetricFilter_IsCfnResource 

func CfnMetricFilter_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnMetricFilter_IsConstruct 

func CfnMetricFilter_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 CfnQueryDefinition_CFN_RESOURCE_TYPE_NAME 

func CfnQueryDefinition_CFN_RESOURCE_TYPE_NAME() *string

func CfnQueryDefinition_IsCfnElement 

func CfnQueryDefinition_IsCfnElement(x interface{}) *bool

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

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

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

func CfnQueryDefinition_IsCfnResource 

func CfnQueryDefinition_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnQueryDefinition_IsConstruct 

func CfnQueryDefinition_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 CfnSubscriptionFilter_CFN_RESOURCE_TYPE_NAME 

func CfnSubscriptionFilter_CFN_RESOURCE_TYPE_NAME() *string

func CfnSubscriptionFilter_IsCfnElement 

func CfnSubscriptionFilter_IsCfnElement(x interface{}) *bool

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

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

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

func CfnSubscriptionFilter_IsCfnResource 

func CfnSubscriptionFilter_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnSubscriptionFilter_IsConstruct 

func CfnSubscriptionFilter_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 CrossAccountDestination_IsConstruct 

func CrossAccountDestination_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 CrossAccountDestination_IsResource 

func CrossAccountDestination_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func LogGroup_IsConstruct 

func LogGroup_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 LogGroup_IsResource 

func LogGroup_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func LogRetention_IsConstruct 

func LogRetention_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 LogStream_IsConstruct 

func LogStream_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 LogStream_IsResource 

func LogStream_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func MetricFilter_IsConstruct 

func MetricFilter_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 MetricFilter_IsResource 

func MetricFilter_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewCfnDestination_Override 

func NewCfnDestination_Override(c CfnDestination, scope constructs.Construct, id *string, props *CfnDestinationProps)

Create a new `AWS::Logs::Destination`.

func NewCfnLogGroup_Override 

func NewCfnLogGroup_Override(c CfnLogGroup, scope constructs.Construct, id *string, props *CfnLogGroupProps)

Create a new `AWS::Logs::LogGroup`.

func NewCfnLogStream_Override 

func NewCfnLogStream_Override(c CfnLogStream, scope constructs.Construct, id *string, props *CfnLogStreamProps)

Create a new `AWS::Logs::LogStream`.

func NewCfnMetricFilter_Override 

func NewCfnMetricFilter_Override(c CfnMetricFilter, scope constructs.Construct, id *string, props *CfnMetricFilterProps)

Create a new `AWS::Logs::MetricFilter`.

func NewCfnQueryDefinition_Override 

func NewCfnQueryDefinition_Override(c CfnQueryDefinition, scope constructs.Construct, id *string, props *CfnQueryDefinitionProps)

Create a new `AWS::Logs::QueryDefinition`.

func NewCfnSubscriptionFilter_Override 

func NewCfnSubscriptionFilter_Override(c CfnSubscriptionFilter, scope constructs.Construct, id *string, props *CfnSubscriptionFilterProps)

Create a new `AWS::Logs::SubscriptionFilter`.

func NewCrossAccountDestination_Override 

func NewCrossAccountDestination_Override(c CrossAccountDestination, scope constructs.Construct, id *string, props *CrossAccountDestinationProps)

Experimental.

func NewFilterPattern_Override 

func NewFilterPattern_Override(f FilterPattern)

Experimental.

func NewJsonPattern_Override 

func NewJsonPattern_Override(j JsonPattern, jsonPatternString *string)

Experimental.

func NewLogGroup_Override 

func NewLogGroup_Override(l LogGroup, scope constructs.Construct, id *string, props *LogGroupProps)

Experimental.

func NewLogRetention_Override 

func NewLogRetention_Override(l LogRetention, scope constructs.Construct, id *string, props *LogRetentionProps)

Experimental.

func NewLogStream_Override 

func NewLogStream_Override(l LogStream, scope constructs.Construct, id *string, props *LogStreamProps)

Experimental.

func NewMetricFilter_Override 

func NewMetricFilter_Override(m MetricFilter, scope constructs.Construct, id *string, props *MetricFilterProps)

Experimental.

func NewSpaceDelimitedTextPattern_Override 

func NewSpaceDelimitedTextPattern_Override(s SpaceDelimitedTextPattern, columns *[]*string, restrictions *map[string]*[]*ColumnRestriction)

Experimental.

func NewSubscriptionFilter_Override 

func NewSubscriptionFilter_Override(s SubscriptionFilter, scope constructs.Construct, id *string, props *SubscriptionFilterProps)

Experimental.

func SubscriptionFilter_IsConstruct 

func SubscriptionFilter_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 SubscriptionFilter_IsResource 

func SubscriptionFilter_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

Types

type CfnDestination 

type CfnDestination interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DestinationName() *string
	SetDestinationName(val *string)
	DestinationPolicy() *string
	SetDestinationPolicy(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	TargetArn() *string
	SetTargetArn(val *string)
	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::Logs::Destination`.

func NewCfnDestination 

func NewCfnDestination(scope constructs.Construct, id *string, props *CfnDestinationProps) CfnDestination

Create a new `AWS::Logs::Destination`.

type CfnDestinationProps 

type CfnDestinationProps struct {
	// `AWS::Logs::Destination.DestinationName`.
	DestinationName *string `json:"destinationName"`
	// `AWS::Logs::Destination.DestinationPolicy`.
	DestinationPolicy *string `json:"destinationPolicy"`
	// `AWS::Logs::Destination.RoleArn`.
	RoleArn *string `json:"roleArn"`
	// `AWS::Logs::Destination.TargetArn`.
	TargetArn *string `json:"targetArn"`
}

Properties for defining a `AWS::Logs::Destination`.

type CfnLogGroup 

type CfnLogGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LogGroupName() *string
	SetLogGroupName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RetentionInDays() *float64
	SetRetentionInDays(val *float64)
	Stack() awscdk.Stack
	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::Logs::LogGroup`.

func NewCfnLogGroup 

func NewCfnLogGroup(scope constructs.Construct, id *string, props *CfnLogGroupProps) CfnLogGroup

Create a new `AWS::Logs::LogGroup`.

type CfnLogGroupProps 

type CfnLogGroupProps struct {
	// `AWS::Logs::LogGroup.KmsKeyId`.
	KmsKeyId *string `json:"kmsKeyId"`
	// `AWS::Logs::LogGroup.LogGroupName`.
	LogGroupName *string `json:"logGroupName"`
	// `AWS::Logs::LogGroup.RetentionInDays`.
	RetentionInDays *float64 `json:"retentionInDays"`
}

Properties for defining a `AWS::Logs::LogGroup`.

type CfnLogStream 

type CfnLogStream interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogGroupName() *string
	SetLogGroupName(val *string)
	LogicalId() *string
	LogStreamName() *string
	SetLogStreamName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	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::Logs::LogStream`.

func NewCfnLogStream 

func NewCfnLogStream(scope constructs.Construct, id *string, props *CfnLogStreamProps) CfnLogStream

Create a new `AWS::Logs::LogStream`.

type CfnLogStreamProps 

type CfnLogStreamProps struct {
	// `AWS::Logs::LogStream.LogGroupName`.
	LogGroupName *string `json:"logGroupName"`
	// `AWS::Logs::LogStream.LogStreamName`.
	LogStreamName *string `json:"logStreamName"`
}

Properties for defining a `AWS::Logs::LogStream`.

type CfnMetricFilter 

type CfnMetricFilter interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	FilterPattern() *string
	SetFilterPattern(val *string)
	LogGroupName() *string
	SetLogGroupName(val *string)
	LogicalId() *string
	MetricTransformations() interface{}
	SetMetricTransformations(val interface{})
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	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::Logs::MetricFilter`.

func NewCfnMetricFilter 

func NewCfnMetricFilter(scope constructs.Construct, id *string, props *CfnMetricFilterProps) CfnMetricFilter

Create a new `AWS::Logs::MetricFilter`.

type CfnMetricFilterProps 

type CfnMetricFilterProps struct {
	// `AWS::Logs::MetricFilter.FilterPattern`.
	FilterPattern *string `json:"filterPattern"`
	// `AWS::Logs::MetricFilter.LogGroupName`.
	LogGroupName *string `json:"logGroupName"`
	// `AWS::Logs::MetricFilter.MetricTransformations`.
	MetricTransformations interface{} `json:"metricTransformations"`
}

Properties for defining a `AWS::Logs::MetricFilter`.

type CfnMetricFilter_MetricTransformationProperty 

type CfnMetricFilter_MetricTransformationProperty struct {
	// `CfnMetricFilter.MetricTransformationProperty.MetricName`.
	MetricName *string `json:"metricName"`
	// `CfnMetricFilter.MetricTransformationProperty.MetricNamespace`.
	MetricNamespace *string `json:"metricNamespace"`
	// `CfnMetricFilter.MetricTransformationProperty.MetricValue`.
	MetricValue *string `json:"metricValue"`
	// `CfnMetricFilter.MetricTransformationProperty.DefaultValue`.
	DefaultValue *float64 `json:"defaultValue"`
}

type CfnQueryDefinition 

type CfnQueryDefinition interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrQueryDefinitionId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogGroupNames() *[]*string
	SetLogGroupNames(val *[]*string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	QueryString() *string
	SetQueryString(val *string)
	Ref() *string
	Stack() awscdk.Stack
	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::Logs::QueryDefinition`.

func NewCfnQueryDefinition 

func NewCfnQueryDefinition(scope constructs.Construct, id *string, props *CfnQueryDefinitionProps) CfnQueryDefinition

Create a new `AWS::Logs::QueryDefinition`.

type CfnQueryDefinitionProps 

type CfnQueryDefinitionProps struct {
	// `AWS::Logs::QueryDefinition.Name`.
	Name *string `json:"name"`
	// `AWS::Logs::QueryDefinition.QueryString`.
	QueryString *string `json:"queryString"`
	// `AWS::Logs::QueryDefinition.LogGroupNames`.
	LogGroupNames *[]*string `json:"logGroupNames"`
}

Properties for defining a `AWS::Logs::QueryDefinition`.

type CfnSubscriptionFilter 

type CfnSubscriptionFilter interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DestinationArn() *string
	SetDestinationArn(val *string)
	FilterPattern() *string
	SetFilterPattern(val *string)
	LogGroupName() *string
	SetLogGroupName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	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::Logs::SubscriptionFilter`.

func NewCfnSubscriptionFilter 

func NewCfnSubscriptionFilter(scope constructs.Construct, id *string, props *CfnSubscriptionFilterProps) CfnSubscriptionFilter

Create a new `AWS::Logs::SubscriptionFilter`.

type CfnSubscriptionFilterProps 

type CfnSubscriptionFilterProps struct {
	// `AWS::Logs::SubscriptionFilter.DestinationArn`.
	DestinationArn *string `json:"destinationArn"`
	// `AWS::Logs::SubscriptionFilter.FilterPattern`.
	FilterPattern *string `json:"filterPattern"`
	// `AWS::Logs::SubscriptionFilter.LogGroupName`.
	LogGroupName *string `json:"logGroupName"`
	// `AWS::Logs::SubscriptionFilter.RoleArn`.
	RoleArn *string `json:"roleArn"`
}

Properties for defining a `AWS::Logs::SubscriptionFilter`.

type ColumnRestriction 

type ColumnRestriction struct {
	// Comparison operator to use.
	// Experimental.
	Comparison *string `json:"comparison"`
	// Number value to compare to.
	//
	// Exactly one of 'stringValue' and 'numberValue' must be set.
	// Experimental.
	NumberValue *float64 `json:"numberValue"`
	// String value to compare to.
	//
	// Exactly one of 'stringValue' and 'numberValue' must be set.
	// Experimental.
	StringValue *string `json:"stringValue"`
}

Experimental.

type CrossAccountDestination 

type CrossAccountDestination interface {
	awscdk.Resource
	ILogSubscriptionDestination
	DestinationArn() *string
	DestinationName() *string
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	PolicyDocument() awsiam.PolicyDocument
	Stack() awscdk.Stack
	AddToPolicy(statement awsiam.PolicyStatement)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Bind(_scope constructs.Construct, _sourceLogGroup ILogGroup) *LogSubscriptionDestinationConfig
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

A new CloudWatch Logs Destination for use in cross-account scenarios.

CrossAccountDestinations are used to subscribe a Kinesis stream in a different account to a CloudWatch Subscription.

Consumers will hardly ever need to use this class. Instead, directly subscribe a Kinesis stream using the integration class in the `@aws-cdk/aws-logs-destinations` package; if necessary, a `CrossAccountDestination` will be created automatically. Experimental.

func NewCrossAccountDestination 

func NewCrossAccountDestination(scope constructs.Construct, id *string, props *CrossAccountDestinationProps) CrossAccountDestination

Experimental.

type CrossAccountDestinationProps 

type CrossAccountDestinationProps struct {
	// The role to assume that grants permissions to write to 'target'.
	//
	// The role must be assumable by 'logs.{REGION}.amazonaws.com'.
	// Experimental.
	Role awsiam.IRole `json:"role"`
	// The log destination target's ARN.
	// Experimental.
	TargetArn *string `json:"targetArn"`
	// The name of the log destination.
	// Experimental.
	DestinationName *string `json:"destinationName"`
}

Properties for a CrossAccountDestination. Experimental.

type FilterPattern 

type FilterPattern interface {
}

A collection of static methods to generate appropriate ILogPatterns. Experimental.

func NewFilterPattern 

func NewFilterPattern() FilterPattern

Experimental.

type IFilterPattern 

type IFilterPattern interface {
	// Experimental.
	LogPatternString() *string
}

Interface for objects that can render themselves to log patterns. Experimental.

func FilterPattern_AllEvents 

func FilterPattern_AllEvents() IFilterPattern

A log pattern that matches all events. Experimental.

func FilterPattern_AllTerms 

func FilterPattern_AllTerms(terms ...*string) IFilterPattern

A log pattern that matches if all the strings given appear in the event. Experimental.

func FilterPattern_AnyTerm 

func FilterPattern_AnyTerm(terms ...*string) IFilterPattern

A log pattern that matches if any of the strings given appear in the event. Experimental.

func FilterPattern_AnyTermGroup 

func FilterPattern_AnyTermGroup(termGroups ...*[]*string) IFilterPattern

A log pattern that matches if any of the given term groups matches the event.

A term group matches an event if all the terms in it appear in the event string. Experimental.

func FilterPattern_Literal 

func FilterPattern_Literal(logPatternString *string) IFilterPattern

Use the given string as log pattern.

See https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html for information on writing log patterns. Experimental.

type ILogGroup 

type ILogGroup interface {
	awscdk.IResource
	// Create a new Metric Filter on this Log Group.
	// Experimental.
	AddMetricFilter(id *string, props *MetricFilterOptions) MetricFilter
	// Create a new Log Stream for this Log Group.
	// Experimental.
	AddStream(id *string, props *StreamOptions) LogStream
	// Create a new Subscription Filter on this Log Group.
	// Experimental.
	AddSubscriptionFilter(id *string, props *SubscriptionFilterOptions) SubscriptionFilter
	// Extract a metric from structured log events in the LogGroup.
	//
	// Creates a MetricFilter on this LogGroup that will extract the value
	// of the indicated JSON field in all records where it occurs.
	//
	// The metric will be available in CloudWatch Metrics under the
	// indicated namespace and name.
	//
	// Returns: A Metric object representing the extracted metric
	// Experimental.
	ExtractMetric(jsonField *string, metricNamespace *string, metricName *string) awscloudwatch.Metric
	// Give the indicated permissions on this log group and all streams.
	// Experimental.
	Grant(grantee awsiam.IGrantable, actions ...*string) awsiam.Grant
	// Give permissions to write to create and write to streams in this log group.
	// Experimental.
	GrantWrite(grantee awsiam.IGrantable) awsiam.Grant
	// Public method to get the physical name of this log group.
	// Experimental.
	LogGroupPhysicalName() *string
	// The ARN of this log group, with ':*' appended.
	// Experimental.
	LogGroupArn() *string
	// The name of this log group.
	// Experimental.
	LogGroupName() *string
}

Experimental.

func LogGroup_FromLogGroupArn 

func LogGroup_FromLogGroupArn(scope constructs.Construct, id *string, logGroupArn *string) ILogGroup

Import an existing LogGroup given its ARN. Experimental.

func LogGroup_FromLogGroupName 

func LogGroup_FromLogGroupName(scope constructs.Construct, id *string, logGroupName *string) ILogGroup

Import an existing LogGroup given its name. Experimental.

type ILogStream 

type ILogStream interface {
	awscdk.IResource
	// The name of this log stream.
	// Experimental.
	LogStreamName() *string
}

Experimental.

func LogStream_FromLogStreamName 

func LogStream_FromLogStreamName(scope constructs.Construct, id *string, logStreamName *string) ILogStream

Import an existing LogGroup. Experimental.

type ILogSubscriptionDestination 

type ILogSubscriptionDestination interface {
	// Return the properties required to send subscription events to this destination.
	//
	// If necessary, the destination can use the properties of the SubscriptionFilter
	// object itself to configure its permissions to allow the subscription to write
	// to it.
	//
	// The destination may reconfigure its own permissions in response to this
	// function call.
	// Experimental.
	Bind(scope constructs.Construct, sourceLogGroup ILogGroup) *LogSubscriptionDestinationConfig
}

Interface for classes that can be the destination of a log Subscription. Experimental.

type JsonPattern 

type JsonPattern interface {
	IFilterPattern
	JsonPatternString() *string
	LogPatternString() *string
}

Base class for patterns that only match JSON log events. Experimental.

func FilterPattern_All 

func FilterPattern_All(patterns ...JsonPattern) JsonPattern

A JSON log pattern that matches if all given JSON log patterns match. Experimental.

func FilterPattern_Any 

func FilterPattern_Any(patterns ...JsonPattern) JsonPattern

A JSON log pattern that matches if any of the given JSON log patterns match. Experimental.

func FilterPattern_BooleanValue 

func FilterPattern_BooleanValue(jsonField *string, value *bool) JsonPattern

A JSON log pattern that matches if the field exists and equals the boolean value. Experimental.

func FilterPattern_Exists 

func FilterPattern_Exists(jsonField *string) JsonPattern

A JSON log patter that matches if the field exists.

This is a readable convenience wrapper over 'field = *' Experimental.

func FilterPattern_IsNull 

func FilterPattern_IsNull(jsonField *string) JsonPattern

A JSON log pattern that matches if the field exists and has the special value 'null'. Experimental.

func FilterPattern_NotExists 

func FilterPattern_NotExists(jsonField *string) JsonPattern

A JSON log pattern that matches if the field does not exist. Experimental.

func FilterPattern_NumberValue 

func FilterPattern_NumberValue(jsonField *string, comparison *string, value *float64) JsonPattern

A JSON log pattern that compares numerical values.

This pattern only matches if the event is a JSON event, and the indicated field inside compares with the value in the indicated way.

Use '$' to indicate the root of the JSON structure. The comparison operator can only compare equality or inequality. The '*' wildcard may appear in the value may at the start or at the end.

For more information, see:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html Experimental.

func FilterPattern_StringValue 

func FilterPattern_StringValue(jsonField *string, comparison *string, value *string) JsonPattern

A JSON log pattern that compares string values.

This pattern only matches if the event is a JSON event, and the indicated field inside compares with the string value.

Use '$' to indicate the root of the JSON structure. The comparison operator can only compare equality or inequality. The '*' wildcard may appear in the value may at the start or at the end.

For more information, see:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html Experimental.

type LogGroup 

type LogGroup interface {
	awscdk.Resource
	ILogGroup
	Env() *awscdk.ResourceEnvironment
	LogGroupArn() *string
	LogGroupName() *string
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	AddMetricFilter(id *string, props *MetricFilterOptions) MetricFilter
	AddStream(id *string, props *StreamOptions) LogStream
	AddSubscriptionFilter(id *string, props *SubscriptionFilterOptions) SubscriptionFilter
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	ExtractMetric(jsonField *string, metricNamespace *string, metricName *string) awscloudwatch.Metric
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Grant(grantee awsiam.IGrantable, actions ...*string) awsiam.Grant
	GrantWrite(grantee awsiam.IGrantable) awsiam.Grant
	LogGroupPhysicalName() *string
	ToString() *string
}

Define a CloudWatch Log Group. Experimental.

func NewLogGroup 

func NewLogGroup(scope constructs.Construct, id *string, props *LogGroupProps) LogGroup

Experimental.

type LogGroupProps 

type LogGroupProps struct {
	// The KMS Key to encrypt the log group with.
	// Experimental.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
	// Name of the log group.
	// Experimental.
	LogGroupName *string `json:"logGroupName"`
	// Determine the removal policy of this log group.
	//
	// Normally you want to retain the log group so you can diagnose issues
	// from logs even after a deployment that no longer includes the log group.
	// In that case, use the normal date-based retention policy to age out your
	// logs.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// How long, in days, the log contents will be retained.
	//
	// To retain all logs, set this value to RetentionDays.INFINITE.
	// Experimental.
	Retention RetentionDays `json:"retention"`
}

Properties for a LogGroup. Experimental.

type LogRetention 

type LogRetention interface {
	constructs.Construct
	LogGroupArn() *string
	Node() constructs.Node
	ToString() *string
}

Creates a custom resource to control the retention policy of a CloudWatch Logs log group.

The log group is created if it doesn't already exist. The policy is removed when `retentionDays` is `undefined` or equal to `Infinity`. Log group can be created in the region that is different from stack region by specifying `logGroupRegion` Experimental.

func NewLogRetention 

func NewLogRetention(scope constructs.Construct, id *string, props *LogRetentionProps) LogRetention

Experimental.

type LogRetentionProps 

type LogRetentionProps struct {
	// The log group name.
	// Experimental.
	LogGroupName *string `json:"logGroupName"`
	// The number of days log events are kept in CloudWatch Logs.
	// Experimental.
	Retention RetentionDays `json:"retention"`
	// The region where the log group should be created.
	// Experimental.
	LogGroupRegion *string `json:"logGroupRegion"`
	// Retry options for all AWS API calls.
	// Experimental.
	LogRetentionRetryOptions *LogRetentionRetryOptions `json:"logRetentionRetryOptions"`
	// The IAM role for the Lambda function associated with the custom resource.
	// Experimental.
	Role awsiam.IRole `json:"role"`
}

Construction properties for a LogRetention. Experimental.

type LogRetentionRetryOptions 

type LogRetentionRetryOptions struct {
	// The base duration to use in the exponential backoff for operation retries.
	// Experimental.
	Base awscdk.Duration `json:"base"`
	// The maximum amount of retries.
	// Experimental.
	MaxRetries *float64 `json:"maxRetries"`
}

Retry options for all AWS API calls. Experimental.

type LogStream 

type LogStream interface {
	awscdk.Resource
	ILogStream
	Env() *awscdk.ResourceEnvironment
	LogStreamName() *string
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

Define a Log Stream in a Log Group. Experimental.

func NewLogStream 

func NewLogStream(scope constructs.Construct, id *string, props *LogStreamProps) LogStream

Experimental.

type LogStreamProps 

type LogStreamProps struct {
	// The log group to create a log stream for.
	// Experimental.
	LogGroup ILogGroup `json:"logGroup"`
	// The name of the log stream to create.
	//
	// The name must be unique within the log group.
	// Experimental.
	LogStreamName *string `json:"logStreamName"`
	// Determine what happens when the log stream resource is removed from the app.
	//
	// Normally you want to retain the log stream so you can diagnose issues from
	// logs even after a deployment that no longer includes the log stream.
	//
	// The date-based retention policy of your log group will age out the logs
	// after a certain time.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
}

Properties for a LogStream. Experimental.

type LogSubscriptionDestinationConfig 

type LogSubscriptionDestinationConfig struct {
	// The ARN of the subscription's destination.
	// Experimental.
	Arn *string `json:"arn"`
	// The role to assume to write log events to the destination.
	// Experimental.
	Role awsiam.IRole `json:"role"`
}

Properties returned by a Subscription destination. Experimental.

type MetricFilter 

type MetricFilter interface {
	awscdk.Resource
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Metric(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	ToString() *string
}

A filter that extracts information from CloudWatch Logs and emits to CloudWatch Metrics. Experimental.

func NewMetricFilter 

func NewMetricFilter(scope constructs.Construct, id *string, props *MetricFilterProps) MetricFilter

Experimental.

type MetricFilterOptions 

type MetricFilterOptions struct {
	// Pattern to search for log events.
	// Experimental.
	FilterPattern IFilterPattern `json:"filterPattern"`
	// The name of the metric to emit.
	// Experimental.
	MetricName *string `json:"metricName"`
	// The namespace of the metric to emit.
	// Experimental.
	MetricNamespace *string `json:"metricNamespace"`
	// The value to emit if the pattern does not match a particular event.
	// Experimental.
	DefaultValue *float64 `json:"defaultValue"`
	// The value to emit for the metric.
	//
	// Can either be a literal number (typically "1"), or the name of a field in the structure
	// to take the value from the matched event. If you are using a field value, the field
	// value must have been matched using the pattern.
	//
	// If you want to specify a field from a matched JSON structure, use '$.fieldName',
	// and make sure the field is in the pattern (if only as '$.fieldName = *').
	//
	// If you want to specify a field from a matched space-delimited structure,
	// use '$fieldName'.
	// Experimental.
	MetricValue *string `json:"metricValue"`
}

Properties for a MetricFilter created from a LogGroup. Experimental.

type MetricFilterProps 

type MetricFilterProps struct {
	// Pattern to search for log events.
	// Experimental.
	FilterPattern IFilterPattern `json:"filterPattern"`
	// The name of the metric to emit.
	// Experimental.
	MetricName *string `json:"metricName"`
	// The namespace of the metric to emit.
	// Experimental.
	MetricNamespace *string `json:"metricNamespace"`
	// The value to emit if the pattern does not match a particular event.
	// Experimental.
	DefaultValue *float64 `json:"defaultValue"`
	// The value to emit for the metric.
	//
	// Can either be a literal number (typically "1"), or the name of a field in the structure
	// to take the value from the matched event. If you are using a field value, the field
	// value must have been matched using the pattern.
	//
	// If you want to specify a field from a matched JSON structure, use '$.fieldName',
	// and make sure the field is in the pattern (if only as '$.fieldName = *').
	//
	// If you want to specify a field from a matched space-delimited structure,
	// use '$fieldName'.
	// Experimental.
	MetricValue *string `json:"metricValue"`
	// The log group to create the filter on.
	// Experimental.
	LogGroup ILogGroup `json:"logGroup"`
}

Properties for a MetricFilter. Experimental.

type RetentionDays 

type RetentionDays string

How long, in days, the log contents will be retained. Experimental. 

const (
	RetentionDays_ONE_DAY         RetentionDays = "ONE_DAY"
	RetentionDays_THREE_DAYS      RetentionDays = "THREE_DAYS"
	RetentionDays_FIVE_DAYS       RetentionDays = "FIVE_DAYS"
	RetentionDays_ONE_WEEK        RetentionDays = "ONE_WEEK"
	RetentionDays_TWO_WEEKS       RetentionDays = "TWO_WEEKS"
	RetentionDays_ONE_MONTH       RetentionDays = "ONE_MONTH"
	RetentionDays_TWO_MONTHS      RetentionDays = "TWO_MONTHS"
	RetentionDays_THREE_MONTHS    RetentionDays = "THREE_MONTHS"
	RetentionDays_FOUR_MONTHS     RetentionDays = "FOUR_MONTHS"
	RetentionDays_FIVE_MONTHS     RetentionDays = "FIVE_MONTHS"
	RetentionDays_SIX_MONTHS      RetentionDays = "SIX_MONTHS"
	RetentionDays_ONE_YEAR        RetentionDays = "ONE_YEAR"
	RetentionDays_THIRTEEN_MONTHS RetentionDays = "THIRTEEN_MONTHS"
	RetentionDays_EIGHTEEN_MONTHS RetentionDays = "EIGHTEEN_MONTHS"
	RetentionDays_TWO_YEARS       RetentionDays = "TWO_YEARS"
	RetentionDays_FIVE_YEARS      RetentionDays = "FIVE_YEARS"
	RetentionDays_TEN_YEARS       RetentionDays = "TEN_YEARS"
	RetentionDays_INFINITE        RetentionDays = "INFINITE"
)

type SpaceDelimitedTextPattern 

type SpaceDelimitedTextPattern interface {
	IFilterPattern
	LogPatternString() *string
	WhereNumber(columnName *string, comparison *string, value *float64) SpaceDelimitedTextPattern
	WhereString(columnName *string, comparison *string, value *string) SpaceDelimitedTextPattern
}

Space delimited text pattern. Experimental.

func FilterPattern_SpaceDelimited 

func FilterPattern_SpaceDelimited(columns ...*string) SpaceDelimitedTextPattern

A space delimited log pattern matcher.

The log event is divided into space-delimited columns (optionally enclosed by "" or [] to capture spaces into column values), and names are given to each column.

'...' may be specified once to match any number of columns.

Afterwards, conditions may be added to individual columns. Experimental.

func NewSpaceDelimitedTextPattern 

func NewSpaceDelimitedTextPattern(columns *[]*string, restrictions *map[string]*[]*ColumnRestriction) SpaceDelimitedTextPattern

Experimental.

func SpaceDelimitedTextPattern_Construct 

func SpaceDelimitedTextPattern_Construct(columns *[]*string) SpaceDelimitedTextPattern

Construct a new instance of a space delimited text pattern.

Since this class must be public, we can't rely on the user only creating it through the `LogPattern.spaceDelimited()` factory function. We must therefore validate the argument in the constructor. Since we're returning a copy on every mutation, and we don't want to re-validate the same things on every construction, we provide a limited set of mutator functions and only validate the new data every time. Experimental.

type StreamOptions 

type StreamOptions struct {
	// The name of the log stream to create.
	//
	// The name must be unique within the log group.
	// Experimental.
	LogStreamName *string `json:"logStreamName"`
}

Properties for a new LogStream created from a LogGroup. Experimental.

type SubscriptionFilter 

type SubscriptionFilter interface {
	awscdk.Resource
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

A new Subscription on a CloudWatch log group. Experimental.

func NewSubscriptionFilter 

func NewSubscriptionFilter(scope constructs.Construct, id *string, props *SubscriptionFilterProps) SubscriptionFilter

Experimental.

type SubscriptionFilterOptions 

type SubscriptionFilterOptions struct {
	// The destination to send the filtered events to.
	//
	// For example, a Kinesis stream or a Lambda function.
	// Experimental.
	Destination ILogSubscriptionDestination `json:"destination"`
	// Log events matching this pattern will be sent to the destination.
	// Experimental.
	FilterPattern IFilterPattern `json:"filterPattern"`
}

Properties for a new SubscriptionFilter created from a LogGroup. Experimental.

type SubscriptionFilterProps 

type SubscriptionFilterProps struct {
	// The destination to send the filtered events to.
	//
	// For example, a Kinesis stream or a Lambda function.
	// Experimental.
	Destination ILogSubscriptionDestination `json:"destination"`
	// Log events matching this pattern will be sent to the destination.
	// Experimental.
	FilterPattern IFilterPattern `json:"filterPattern"`
	// The log group to create the subscription on.
	// Experimental.
	LogGroup ILogGroup `json:"logGroup"`
}

Properties for a SubscriptionFilter. Experimental.

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.