Documentation
¶
Index ¶
- func CfnInvestigationGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInvestigationGroup_IsCfnElement(x interface{}) *bool
- func CfnInvestigationGroup_IsCfnResource(x interface{}) *bool
- func CfnInvestigationGroup_IsConstruct(x interface{}) *bool
- func NewCfnInvestigationGroup_Override(c CfnInvestigationGroup, scope constructs.Construct, id *string, ...)
- type CfnInvestigationGroup
- type CfnInvestigationGroupProps
- type CfnInvestigationGroup_ChatbotNotificationChannelProperty
- type CfnInvestigationGroup_CrossAccountConfigurationProperty
- type CfnInvestigationGroup_EncryptionConfigMapProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnInvestigationGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnInvestigationGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnInvestigationGroup_IsCfnElement ¶
func CfnInvestigationGroup_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 CfnInvestigationGroup_IsCfnResource ¶
func CfnInvestigationGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInvestigationGroup_IsConstruct ¶
func CfnInvestigationGroup_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 NewCfnInvestigationGroup_Override ¶
func NewCfnInvestigationGroup_Override(c CfnInvestigationGroup, scope constructs.Construct, id *string, props *CfnInvestigationGroupProps)
Types ¶
type CfnInvestigationGroup ¶
type CfnInvestigationGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Investigation Group's ARN. AttrArn() *string // The timestamp value. AttrCreatedAt() *string // User friendly name for resources. AttrCreatedBy() *string // User friendly name for resources. AttrLastModifiedAt() *string // User friendly name for resources. AttrLastModifiedBy() *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 // An array of key-value pairs of notification channels to apply to this resource. ChatbotNotificationChannels() interface{} SetChatbotNotificationChannels(val interface{}) // 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 // An array of cross account configurations. CrossAccountConfigurations() interface{} SetCrossAccountConfigurations(val interface{}) EncryptionConfig() interface{} SetEncryptionConfig(val interface{}) // Investigation Group policy. InvestigationGroupPolicy() *string SetInvestigationGroupPolicy(val *string) // Flag to enable cloud trail history. IsCloudTrailEventHistoryEnabled() interface{} SetIsCloudTrailEventHistoryEnabled(val interface{}) // 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 // User friendly name for resources. Name() *string SetName(val *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 number of days to retain the investigation group. RetentionInDays() *float64 SetRetentionInDays(val *float64) // The Investigation Role's ARN. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack TagKeyBoundaries() *[]*string SetTagKeyBoundaries(val *[]*string) // 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://docs.aws.amazon.com/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://docs.aws.amazon.com/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://docs.aws.amazon.com/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{}) }
Definition of AWS::AIOps::InvestigationGroup Resource Type.
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" cfnInvestigationGroup := awscdk.Aws_aiops.NewCfnInvestigationGroup(this, jsii.String("MyCfnInvestigationGroup"), &CfnInvestigationGroupProps{ Name: jsii.String("name"), // the properties below are optional ChatbotNotificationChannels: []interface{}{ &ChatbotNotificationChannelProperty{ ChatConfigurationArns: []*string{ jsii.String("chatConfigurationArns"), }, SnsTopicArn: jsii.String("snsTopicArn"), }, }, CrossAccountConfigurations: []interface{}{ &CrossAccountConfigurationProperty{ SourceRoleArn: jsii.String("sourceRoleArn"), }, }, EncryptionConfig: &EncryptionConfigMapProperty{ EncryptionConfigurationType: jsii.String("encryptionConfigurationType"), KmsKeyId: jsii.String("kmsKeyId"), }, InvestigationGroupPolicy: jsii.String("investigationGroupPolicy"), IsCloudTrailEventHistoryEnabled: jsii.Boolean(false), RetentionInDays: jsii.Number(123), RoleArn: jsii.String("roleArn"), TagKeyBoundaries: []*string{ jsii.String("tagKeyBoundaries"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnInvestigationGroup ¶
func NewCfnInvestigationGroup(scope constructs.Construct, id *string, props *CfnInvestigationGroupProps) CfnInvestigationGroup
type CfnInvestigationGroupProps ¶
type CfnInvestigationGroupProps struct { // User friendly name for resources. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-name // Name *string `field:"required" json:"name" yaml:"name"` // An array of key-value pairs of notification channels to apply to this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-chatbotnotificationchannels // ChatbotNotificationChannels interface{} `field:"optional" json:"chatbotNotificationChannels" yaml:"chatbotNotificationChannels"` // An array of cross account configurations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-crossaccountconfigurations // CrossAccountConfigurations interface{} `field:"optional" json:"crossAccountConfigurations" yaml:"crossAccountConfigurations"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-encryptionconfig // EncryptionConfig interface{} `field:"optional" json:"encryptionConfig" yaml:"encryptionConfig"` // Investigation Group policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-investigationgrouppolicy // InvestigationGroupPolicy *string `field:"optional" json:"investigationGroupPolicy" yaml:"investigationGroupPolicy"` // Flag to enable cloud trail history. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-iscloudtraileventhistoryenabled // IsCloudTrailEventHistoryEnabled interface{} `field:"optional" json:"isCloudTrailEventHistoryEnabled" yaml:"isCloudTrailEventHistoryEnabled"` // The number of days to retain the investigation group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-retentionindays // RetentionInDays *float64 `field:"optional" json:"retentionInDays" yaml:"retentionInDays"` // The Investigation Role's ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-rolearn // RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-tagkeyboundaries // TagKeyBoundaries *[]*string `field:"optional" json:"tagKeyBoundaries" yaml:"tagKeyBoundaries"` // An array of key-value pairs to apply to this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnInvestigationGroup`.
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" cfnInvestigationGroupProps := &CfnInvestigationGroupProps{ Name: jsii.String("name"), // the properties below are optional ChatbotNotificationChannels: []interface{}{ &ChatbotNotificationChannelProperty{ ChatConfigurationArns: []*string{ jsii.String("chatConfigurationArns"), }, SnsTopicArn: jsii.String("snsTopicArn"), }, }, CrossAccountConfigurations: []interface{}{ &CrossAccountConfigurationProperty{ SourceRoleArn: jsii.String("sourceRoleArn"), }, }, EncryptionConfig: &EncryptionConfigMapProperty{ EncryptionConfigurationType: jsii.String("encryptionConfigurationType"), KmsKeyId: jsii.String("kmsKeyId"), }, InvestigationGroupPolicy: jsii.String("investigationGroupPolicy"), IsCloudTrailEventHistoryEnabled: jsii.Boolean(false), RetentionInDays: jsii.Number(123), RoleArn: jsii.String("roleArn"), TagKeyBoundaries: []*string{ jsii.String("tagKeyBoundaries"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnInvestigationGroup_ChatbotNotificationChannelProperty ¶
type CfnInvestigationGroup_ChatbotNotificationChannelProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-chatbotnotificationchannel.html#cfn-aiops-investigationgroup-chatbotnotificationchannel-chatconfigurationarns // ChatConfigurationArns *[]*string `field:"optional" json:"chatConfigurationArns" yaml:"chatConfigurationArns"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-chatbotnotificationchannel.html#cfn-aiops-investigationgroup-chatbotnotificationchannel-snstopicarn // SnsTopicArn *string `field:"optional" json:"snsTopicArn" yaml:"snsTopicArn"` }
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" chatbotNotificationChannelProperty := &ChatbotNotificationChannelProperty{ ChatConfigurationArns: []*string{ jsii.String("chatConfigurationArns"), }, SnsTopicArn: jsii.String("snsTopicArn"), }
type CfnInvestigationGroup_CrossAccountConfigurationProperty ¶
type CfnInvestigationGroup_CrossAccountConfigurationProperty struct { // The Investigation Role's ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-crossaccountconfiguration.html#cfn-aiops-investigationgroup-crossaccountconfiguration-sourcerolearn // SourceRoleArn *string `field:"optional" json:"sourceRoleArn" yaml:"sourceRoleArn"` }
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" crossAccountConfigurationProperty := &CrossAccountConfigurationProperty{ SourceRoleArn: jsii.String("sourceRoleArn"), }
type CfnInvestigationGroup_EncryptionConfigMapProperty ¶
type CfnInvestigationGroup_EncryptionConfigMapProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-encryptionconfigmap.html#cfn-aiops-investigationgroup-encryptionconfigmap-encryptionconfigurationtype // EncryptionConfigurationType *string `field:"optional" json:"encryptionConfigurationType" yaml:"encryptionConfigurationType"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-encryptionconfigmap.html#cfn-aiops-investigationgroup-encryptionconfigmap-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
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" encryptionConfigMapProperty := &EncryptionConfigMapProperty{ EncryptionConfigurationType: jsii.String("encryptionConfigurationType"), KmsKeyId: jsii.String("kmsKeyId"), }