Documentation ¶
Index ¶
- func CfnDetector_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDetector_IsCfnElement(x interface{}) *bool
- func CfnDetector_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDetector_IsConstruct(x interface{}) *bool
- func CfnEntityType_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEntityType_IsCfnElement(x interface{}) *bool
- func CfnEntityType_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnEntityType_IsConstruct(x interface{}) *bool
- func CfnEventType_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEventType_IsCfnElement(x interface{}) *bool
- func CfnEventType_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnEventType_IsConstruct(x interface{}) *bool
- func CfnLabel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLabel_IsCfnElement(x interface{}) *bool
- func CfnLabel_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLabel_IsConstruct(x interface{}) *bool
- func CfnOutcome_CFN_RESOURCE_TYPE_NAME() *string
- func CfnOutcome_IsCfnElement(x interface{}) *bool
- func CfnOutcome_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnOutcome_IsConstruct(x interface{}) *bool
- func CfnVariable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVariable_IsCfnElement(x interface{}) *bool
- func CfnVariable_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnVariable_IsConstruct(x interface{}) *bool
- func NewCfnDetector_Override(c CfnDetector, scope awscdk.Construct, id *string, props *CfnDetectorProps)
- func NewCfnEntityType_Override(c CfnEntityType, scope awscdk.Construct, id *string, props *CfnEntityTypeProps)
- func NewCfnEventType_Override(c CfnEventType, scope awscdk.Construct, id *string, props *CfnEventTypeProps)
- func NewCfnLabel_Override(c CfnLabel, scope awscdk.Construct, id *string, props *CfnLabelProps)
- func NewCfnOutcome_Override(c CfnOutcome, scope awscdk.Construct, id *string, props *CfnOutcomeProps)
- func NewCfnVariable_Override(c CfnVariable, scope awscdk.Construct, id *string, props *CfnVariableProps)
- type CfnDetector
- type CfnDetectorProps
- type CfnDetector_EntityTypeProperty
- type CfnDetector_EventTypeProperty
- type CfnDetector_EventVariableProperty
- type CfnDetector_LabelProperty
- type CfnDetector_ModelProperty
- type CfnDetector_OutcomeProperty
- type CfnDetector_RuleProperty
- type CfnEntityType
- type CfnEntityTypeProps
- type CfnEventType
- type CfnEventTypeProps
- type CfnEventType_EntityTypeProperty
- type CfnEventType_EventVariableProperty
- type CfnEventType_LabelProperty
- type CfnLabel
- type CfnLabelProps
- type CfnOutcome
- type CfnOutcomeProps
- type CfnVariable
- type CfnVariableProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnDetector_CFN_RESOURCE_TYPE_NAME ¶
func CfnDetector_CFN_RESOURCE_TYPE_NAME() *string
func CfnDetector_IsCfnElement ¶
func CfnDetector_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 CfnDetector_IsCfnResource ¶
func CfnDetector_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDetector_IsConstruct ¶
func CfnDetector_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnEntityType_CFN_RESOURCE_TYPE_NAME ¶
func CfnEntityType_CFN_RESOURCE_TYPE_NAME() *string
func CfnEntityType_IsCfnElement ¶
func CfnEntityType_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 CfnEntityType_IsCfnResource ¶
func CfnEntityType_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnEntityType_IsConstruct ¶
func CfnEntityType_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnEventType_CFN_RESOURCE_TYPE_NAME ¶
func CfnEventType_CFN_RESOURCE_TYPE_NAME() *string
func CfnEventType_IsCfnElement ¶
func CfnEventType_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 CfnEventType_IsCfnResource ¶
func CfnEventType_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnEventType_IsConstruct ¶
func CfnEventType_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnLabel_CFN_RESOURCE_TYPE_NAME ¶
func CfnLabel_CFN_RESOURCE_TYPE_NAME() *string
func CfnLabel_IsCfnElement ¶
func CfnLabel_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 CfnLabel_IsCfnResource ¶
func CfnLabel_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnLabel_IsConstruct ¶
func CfnLabel_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnOutcome_CFN_RESOURCE_TYPE_NAME ¶
func CfnOutcome_CFN_RESOURCE_TYPE_NAME() *string
func CfnOutcome_IsCfnElement ¶
func CfnOutcome_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 CfnOutcome_IsCfnResource ¶
func CfnOutcome_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnOutcome_IsConstruct ¶
func CfnOutcome_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnVariable_CFN_RESOURCE_TYPE_NAME ¶
func CfnVariable_CFN_RESOURCE_TYPE_NAME() *string
func CfnVariable_IsCfnElement ¶
func CfnVariable_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 CfnVariable_IsCfnResource ¶
func CfnVariable_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnVariable_IsConstruct ¶
func CfnVariable_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnDetector_Override ¶
func NewCfnDetector_Override(c CfnDetector, scope awscdk.Construct, id *string, props *CfnDetectorProps)
Create a new `AWS::FraudDetector::Detector`.
func NewCfnEntityType_Override ¶
func NewCfnEntityType_Override(c CfnEntityType, scope awscdk.Construct, id *string, props *CfnEntityTypeProps)
Create a new `AWS::FraudDetector::EntityType`.
func NewCfnEventType_Override ¶
func NewCfnEventType_Override(c CfnEventType, scope awscdk.Construct, id *string, props *CfnEventTypeProps)
Create a new `AWS::FraudDetector::EventType`.
func NewCfnLabel_Override ¶
func NewCfnLabel_Override(c CfnLabel, scope awscdk.Construct, id *string, props *CfnLabelProps)
Create a new `AWS::FraudDetector::Label`.
func NewCfnOutcome_Override ¶
func NewCfnOutcome_Override(c CfnOutcome, scope awscdk.Construct, id *string, props *CfnOutcomeProps)
Create a new `AWS::FraudDetector::Outcome`.
func NewCfnVariable_Override ¶
func NewCfnVariable_Override(c CfnVariable, scope awscdk.Construct, id *string, props *CfnVariableProps)
Create a new `AWS::FraudDetector::Variable`.
Types ¶
type CfnDetector ¶
type CfnDetector interface { awscdk.CfnResource awscdk.IInspectable // The models to associate with this detector. // // You must provide the ARNs of all the models you want to associate. AssociatedModels() interface{} SetAssociatedModels(val interface{}) // The detector ARN. AttrArn() *string // Timestamp of when detector was created. AttrCreatedTime() *string // The name of the detector. AttrDetectorVersionId() *string AttrEventTypeArn() *string AttrEventTypeCreatedTime() *string AttrEventTypeLastUpdatedTime() *string // Timestamp of when detector was last updated. AttrLastUpdatedTime() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // The detector description. Description() *string SetDescription(val *string) // The name of the detector. DetectorId() *string SetDetectorId(val *string) // The status of the detector version. // // If a value is not provided for this property, AWS CloudFormation assumes `DRAFT` status. // // Valid values: `ACTIVE | DRAFT`. DetectorVersionStatus() *string SetDetectorVersionStatus(val *string) // The event type associated with this detector. EventType() interface{} SetEventType(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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The rule execution mode for the rules included in the detector version. // // Valid values: `FIRST_MATCHED | ALL_MATCHED` Default value: `FIRST_MATCHED` // // You can define and edit the rule mode at the detector version level, when it is in draft status. // // If you specify `FIRST_MATCHED` , Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. // // If you specifiy `ALL_MATCHED` , Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. RuleExecutionMode() *string SetRuleExecutionMode(val *string) // The rules to include in the detector version. Rules() interface{} SetRules(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::FraudDetector::Detector`.
Manages a detector and associated detector versions.
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" cfnDetector := awscdk.Aws_frauddetector.NewCfnDetector(this, jsii.String("MyCfnDetector"), &cfnDetectorProps{ detectorId: jsii.String("detectorId"), eventType: &eventTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), entityTypes: []interface{}{ &entityTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, eventVariables: []interface{}{ &eventVariableProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), dataSource: jsii.String("dataSource"), dataType: jsii.String("dataType"), defaultValue: jsii.String("defaultValue"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, variableType: jsii.String("variableType"), }, }, inline: jsii.Boolean(false), labels: []interface{}{ &labelProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, rules: []interface{}{ &ruleProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), detectorId: jsii.String("detectorId"), expression: jsii.String("expression"), language: jsii.String("language"), lastUpdatedTime: jsii.String("lastUpdatedTime"), outcomes: []interface{}{ &outcomeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, ruleId: jsii.String("ruleId"), ruleVersion: jsii.String("ruleVersion"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, // the properties below are optional associatedModels: []interface{}{ &modelProperty{ arn: jsii.String("arn"), }, }, description: jsii.String("description"), detectorVersionStatus: jsii.String("detectorVersionStatus"), ruleExecutionMode: jsii.String("ruleExecutionMode"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnDetector ¶
func NewCfnDetector(scope awscdk.Construct, id *string, props *CfnDetectorProps) CfnDetector
Create a new `AWS::FraudDetector::Detector`.
type CfnDetectorProps ¶
type CfnDetectorProps struct { // The name of the detector. DetectorId *string `field:"required" json:"detectorId" yaml:"detectorId"` // The event type associated with this detector. EventType interface{} `field:"required" json:"eventType" yaml:"eventType"` // The rules to include in the detector version. Rules interface{} `field:"required" json:"rules" yaml:"rules"` // The models to associate with this detector. // // You must provide the ARNs of all the models you want to associate. AssociatedModels interface{} `field:"optional" json:"associatedModels" yaml:"associatedModels"` // The detector description. Description *string `field:"optional" json:"description" yaml:"description"` // The status of the detector version. // // If a value is not provided for this property, AWS CloudFormation assumes `DRAFT` status. // // Valid values: `ACTIVE | DRAFT`. DetectorVersionStatus *string `field:"optional" json:"detectorVersionStatus" yaml:"detectorVersionStatus"` // The rule execution mode for the rules included in the detector version. // // Valid values: `FIRST_MATCHED | ALL_MATCHED` Default value: `FIRST_MATCHED` // // You can define and edit the rule mode at the detector version level, when it is in draft status. // // If you specify `FIRST_MATCHED` , Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. // // If you specifiy `ALL_MATCHED` , Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. RuleExecutionMode *string `field:"optional" json:"ruleExecutionMode" yaml:"ruleExecutionMode"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDetector`.
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" cfnDetectorProps := &cfnDetectorProps{ detectorId: jsii.String("detectorId"), eventType: &eventTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), entityTypes: []interface{}{ &entityTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, eventVariables: []interface{}{ &eventVariableProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), dataSource: jsii.String("dataSource"), dataType: jsii.String("dataType"), defaultValue: jsii.String("defaultValue"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, variableType: jsii.String("variableType"), }, }, inline: jsii.Boolean(false), labels: []interface{}{ &labelProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, rules: []interface{}{ &ruleProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), detectorId: jsii.String("detectorId"), expression: jsii.String("expression"), language: jsii.String("language"), lastUpdatedTime: jsii.String("lastUpdatedTime"), outcomes: []interface{}{ &outcomeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, ruleId: jsii.String("ruleId"), ruleVersion: jsii.String("ruleVersion"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, // the properties below are optional associatedModels: []interface{}{ &modelProperty{ arn: jsii.String("arn"), }, }, description: jsii.String("description"), detectorVersionStatus: jsii.String("detectorVersionStatus"), ruleExecutionMode: jsii.String("ruleExecutionMode"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnDetector_EntityTypeProperty ¶
type CfnDetector_EntityTypeProperty struct { // The entity type ARN. Arn *string `field:"optional" json:"arn" yaml:"arn"` // Timestamp of when the entity type was created. CreatedTime *string `field:"optional" json:"createdTime" yaml:"createdTime"` // The entity type description. Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. // // If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. // // For example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these Variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables. Inline interface{} `field:"optional" json:"inline" yaml:"inline"` // Timestamp of when the entity type was last updated. LastUpdatedTime *string `field:"optional" json:"lastUpdatedTime" yaml:"lastUpdatedTime"` // The entity type name. Name *string `field:"optional" json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
The entity type details.
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" entityTypeProperty := &entityTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnDetector_EventTypeProperty ¶
type CfnDetector_EventTypeProperty struct { // The entity type ARN. Arn *string `field:"optional" json:"arn" yaml:"arn"` // Timestamp of when the event type was created. CreatedTime *string `field:"optional" json:"createdTime" yaml:"createdTime"` // The event type description. Description *string `field:"optional" json:"description" yaml:"description"` // The event type entity types. EntityTypes interface{} `field:"optional" json:"entityTypes" yaml:"entityTypes"` // The event type event variables. EventVariables interface{} `field:"optional" json:"eventVariables" yaml:"eventVariables"` // Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. // // If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. // // For example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the Variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables. Inline interface{} `field:"optional" json:"inline" yaml:"inline"` // The event type labels. Labels interface{} `field:"optional" json:"labels" yaml:"labels"` // Timestamp of when the event type was last updated. LastUpdatedTime *string `field:"optional" json:"lastUpdatedTime" yaml:"lastUpdatedTime"` // The event type name. Name *string `field:"optional" json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
The event type details.
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" eventTypeProperty := &eventTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), entityTypes: []interface{}{ &entityTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, eventVariables: []interface{}{ &eventVariableProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), dataSource: jsii.String("dataSource"), dataType: jsii.String("dataType"), defaultValue: jsii.String("defaultValue"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, variableType: jsii.String("variableType"), }, }, inline: jsii.Boolean(false), labels: []interface{}{ &labelProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnDetector_EventVariableProperty ¶
type CfnDetector_EventVariableProperty struct { // The event variable ARN. Arn *string `field:"optional" json:"arn" yaml:"arn"` // Timestamp for when the event variable was created. CreatedTime *string `field:"optional" json:"createdTime" yaml:"createdTime"` // The data source of the event variable. // // Valid values: `EVENT | EXTERNAL_MODEL_SCORE` // // When defining a variable within a detector, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true. If the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource. DataSource *string `field:"optional" json:"dataSource" yaml:"dataSource"` // The data type of the event variable. // // Valid values: `STRING | INTEGER | BOOLEAN | FLOAT`. DataType *string `field:"optional" json:"dataType" yaml:"dataType"` // The default value of the event variable. // // This is required if you are providing the details of your variables instead of the ARN. DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"` // The description of the event variable. Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. // // If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. // // For example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables. Inline interface{} `field:"optional" json:"inline" yaml:"inline"` // Timestamp for when the event variable was last updated. LastUpdatedTime *string `field:"optional" json:"lastUpdatedTime" yaml:"lastUpdatedTime"` // The name of the event variable. Name *string `field:"optional" json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The type of event variable. // // For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) . VariableType *string `field:"optional" json:"variableType" yaml:"variableType"` }
The event type variable for the detector.
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" eventVariableProperty := &eventVariableProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), dataSource: jsii.String("dataSource"), dataType: jsii.String("dataType"), defaultValue: jsii.String("defaultValue"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, variableType: jsii.String("variableType"), }
type CfnDetector_LabelProperty ¶
type CfnDetector_LabelProperty struct { // The label ARN. Arn *string `field:"optional" json:"arn" yaml:"arn"` // Timestamp of when the event type was created. CreatedTime *string `field:"optional" json:"createdTime" yaml:"createdTime"` // The label description. Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. // // If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. // // For example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables. Inline interface{} `field:"optional" json:"inline" yaml:"inline"` // Timestamp of when the label was last updated. LastUpdatedTime *string `field:"optional" json:"lastUpdatedTime" yaml:"lastUpdatedTime"` // The label name. Name *string `field:"optional" json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
The label details.
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" labelProperty := &labelProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnDetector_ModelProperty ¶
type CfnDetector_ModelProperty struct { // The ARN of the model. Arn *string `field:"optional" json:"arn" yaml:"arn"` }
The model.
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" modelProperty := &modelProperty{ arn: jsii.String("arn"), }
type CfnDetector_OutcomeProperty ¶
type CfnDetector_OutcomeProperty struct { // The outcome ARN. Arn *string `field:"optional" json:"arn" yaml:"arn"` // The timestamp when the outcome was created. CreatedTime *string `field:"optional" json:"createdTime" yaml:"createdTime"` // The outcome description. Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. // // If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. // // For example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables. Inline interface{} `field:"optional" json:"inline" yaml:"inline"` // The timestamp when the outcome was last updated. LastUpdatedTime *string `field:"optional" json:"lastUpdatedTime" yaml:"lastUpdatedTime"` // The outcome name. Name *string `field:"optional" json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
The outcome.
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" outcomeProperty := &outcomeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnDetector_RuleProperty ¶
type CfnDetector_RuleProperty struct { // The rule ARN. Arn *string `field:"optional" json:"arn" yaml:"arn"` // Timestamp for when the rule was created. CreatedTime *string `field:"optional" json:"createdTime" yaml:"createdTime"` // The rule description. Description *string `field:"optional" json:"description" yaml:"description"` // The detector for which the rule is associated. DetectorId *string `field:"optional" json:"detectorId" yaml:"detectorId"` // The rule expression. // // A rule expression captures the business logic. For more information, see [Rule language reference](https://docs.aws.amazon.com/frauddetector/latest/ug/rule-language-reference.html) . Expression *string `field:"optional" json:"expression" yaml:"expression"` // The rule language. Language *string `field:"optional" json:"language" yaml:"language"` // Timestamp for when the rule was last updated. LastUpdatedTime *string `field:"optional" json:"lastUpdatedTime" yaml:"lastUpdatedTime"` // The rule outcome. Outcomes interface{} `field:"optional" json:"outcomes" yaml:"outcomes"` // The rule ID. RuleId *string `field:"optional" json:"ruleId" yaml:"ruleId"` // The rule version. RuleVersion *string `field:"optional" json:"ruleVersion" yaml:"ruleVersion"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
A rule.
Rule is a condition that tells Amazon Fraud Detector how to interpret variables values during a fraud prediction.
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" ruleProperty := &ruleProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), detectorId: jsii.String("detectorId"), expression: jsii.String("expression"), language: jsii.String("language"), lastUpdatedTime: jsii.String("lastUpdatedTime"), outcomes: []interface{}{ &outcomeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, ruleId: jsii.String("ruleId"), ruleVersion: jsii.String("ruleVersion"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnEntityType ¶
type CfnEntityType interface { awscdk.CfnResource awscdk.IInspectable // The entity type ARN. AttrArn() *string // Timestamp of when entity type was created. AttrCreatedTime() *string // Timestamp of when entity type was last updated. AttrLastUpdatedTime() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // The entity type description. Description() *string SetDescription(val *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. // Experimental. LogicalId() *string // The entity type name. // // Pattern: `^[0-9a-z_-]+$`. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // A key and value pair. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::FraudDetector::EntityType`.
Manages an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.
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" cfnEntityType := awscdk.Aws_frauddetector.NewCfnEntityType(this, jsii.String("MyCfnEntityType"), &cfnEntityTypeProps{ name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnEntityType ¶
func NewCfnEntityType(scope awscdk.Construct, id *string, props *CfnEntityTypeProps) CfnEntityType
Create a new `AWS::FraudDetector::EntityType`.
type CfnEntityTypeProps ¶
type CfnEntityTypeProps struct { // The entity type name. // // Pattern: `^[0-9a-z_-]+$`. Name *string `field:"required" json:"name" yaml:"name"` // The entity type description. Description *string `field:"optional" json:"description" yaml:"description"` // A key and value pair. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnEntityType`.
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" cfnEntityTypeProps := &cfnEntityTypeProps{ name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnEventType ¶
type CfnEventType interface { awscdk.CfnResource awscdk.IInspectable // The event type ARN. AttrArn() *string // Timestamp of when event type was created. AttrCreatedTime() *string // Timestamp of when event type was last updated. AttrLastUpdatedTime() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // The event type description. Description() *string SetDescription(val *string) // The event type entity types. EntityTypes() interface{} SetEntityTypes(val interface{}) // The event type event variables. EventVariables() interface{} SetEventVariables(val interface{}) // The event type labels. Labels() interface{} SetLabels(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. // Experimental. LogicalId() *string // The event type name. // // Pattern : `^[0-9a-z_-]+$`. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::FraudDetector::EventType`.
Manages an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.
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" cfnEventType := awscdk.Aws_frauddetector.NewCfnEventType(this, jsii.String("MyCfnEventType"), &cfnEventTypeProps{ entityTypes: []interface{}{ &entityTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, eventVariables: []interface{}{ &eventVariableProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), dataSource: jsii.String("dataSource"), dataType: jsii.String("dataType"), defaultValue: jsii.String("defaultValue"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, variableType: jsii.String("variableType"), }, }, labels: []interface{}{ &labelProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnEventType ¶
func NewCfnEventType(scope awscdk.Construct, id *string, props *CfnEventTypeProps) CfnEventType
Create a new `AWS::FraudDetector::EventType`.
type CfnEventTypeProps ¶
type CfnEventTypeProps struct { // The event type entity types. EntityTypes interface{} `field:"required" json:"entityTypes" yaml:"entityTypes"` // The event type event variables. EventVariables interface{} `field:"required" json:"eventVariables" yaml:"eventVariables"` // The event type labels. Labels interface{} `field:"required" json:"labels" yaml:"labels"` // The event type name. // // Pattern : `^[0-9a-z_-]+$`. Name *string `field:"required" json:"name" yaml:"name"` // The event type description. Description *string `field:"optional" json:"description" yaml:"description"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnEventType`.
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" cfnEventTypeProps := &cfnEventTypeProps{ entityTypes: []interface{}{ &entityTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, eventVariables: []interface{}{ &eventVariableProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), dataSource: jsii.String("dataSource"), dataType: jsii.String("dataType"), defaultValue: jsii.String("defaultValue"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, variableType: jsii.String("variableType"), }, }, labels: []interface{}{ &labelProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }, }, name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []*cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnEventType_EntityTypeProperty ¶
type CfnEventType_EntityTypeProperty struct { // The entity type ARN. Arn *string `field:"optional" json:"arn" yaml:"arn"` // Timestamp of when the entity type was created. CreatedTime *string `field:"optional" json:"createdTime" yaml:"createdTime"` // The entity type description. Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. // // If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. // // For example, when creating `AWS::FraudDetector::EventType` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your event type but not execute any changes to the variables. Inline interface{} `field:"optional" json:"inline" yaml:"inline"` // Timestamp of when the entity type was last updated. LastUpdatedTime *string `field:"optional" json:"lastUpdatedTime" yaml:"lastUpdatedTime"` // The entity type name. // // `^[0-9a-z_-]+$`. Name *string `field:"optional" json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
The entity type details.
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" entityTypeProperty := &entityTypeProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnEventType_EventVariableProperty ¶
type CfnEventType_EventVariableProperty struct { // The event variable ARN. Arn *string `field:"optional" json:"arn" yaml:"arn"` // Timestamp for when event variable was created. CreatedTime *string `field:"optional" json:"createdTime" yaml:"createdTime"` // The source of the event variable. // // Valid values: `EVENT | EXTERNAL_MODEL_SCORE` // // When defining a variable within a event type, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true. If the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource. DataSource *string `field:"optional" json:"dataSource" yaml:"dataSource"` // The data type of the event variable. DataType *string `field:"optional" json:"dataType" yaml:"dataType"` // The default value of the event variable. DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"` // The event variable description. Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. // // If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. // // For example, when creating `AWS::FraudDetector::EventType` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the Variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your event type but not execute any changes to the variables. Inline interface{} `field:"optional" json:"inline" yaml:"inline"` // Timestamp for when the event variable was last updated. LastUpdatedTime *string `field:"optional" json:"lastUpdatedTime" yaml:"lastUpdatedTime"` // The name of the event variable. Name *string `field:"optional" json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The type of event variable. // // For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) . VariableType *string `field:"optional" json:"variableType" yaml:"variableType"` }
The variables associated with this event 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" eventVariableProperty := &eventVariableProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), dataSource: jsii.String("dataSource"), dataType: jsii.String("dataType"), defaultValue: jsii.String("defaultValue"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, variableType: jsii.String("variableType"), }
type CfnEventType_LabelProperty ¶
type CfnEventType_LabelProperty struct { // The label ARN. Arn *string `field:"optional" json:"arn" yaml:"arn"` // Timestamp of when the event type was created. CreatedTime *string `field:"optional" json:"createdTime" yaml:"createdTime"` // The label description. Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. // // If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. // // For example, when creating `AWS::FraudDetector::EventType` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your EventType but not execute any changes to the variables. Inline interface{} `field:"optional" json:"inline" yaml:"inline"` // Timestamp of when the label was last updated. LastUpdatedTime *string `field:"optional" json:"lastUpdatedTime" yaml:"lastUpdatedTime"` // The label name. Name *string `field:"optional" json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
The label associated with the event 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" labelProperty := &labelProperty{ arn: jsii.String("arn"), createdTime: jsii.String("createdTime"), description: jsii.String("description"), inline: jsii.Boolean(false), lastUpdatedTime: jsii.String("lastUpdatedTime"), name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnLabel ¶
type CfnLabel interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the label. AttrArn() *string // Timestamp of when label was created. AttrCreatedTime() *string // Timestamp of when label was last updated. AttrLastUpdatedTime() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // The label description. Description() *string SetDescription(val *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. // Experimental. LogicalId() *string // The label name. // // Pattern: `^[0-9a-z_-]+$`. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::FraudDetector::Label`.
Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.
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" cfnLabel := awscdk.Aws_frauddetector.NewCfnLabel(this, jsii.String("MyCfnLabel"), &cfnLabelProps{ name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnLabel ¶
func NewCfnLabel(scope awscdk.Construct, id *string, props *CfnLabelProps) CfnLabel
Create a new `AWS::FraudDetector::Label`.
type CfnLabelProps ¶
type CfnLabelProps struct { // The label name. // // Pattern: `^[0-9a-z_-]+$`. Name *string `field:"required" json:"name" yaml:"name"` // The label description. Description *string `field:"optional" json:"description" yaml:"description"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnLabel`.
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" cfnLabelProps := &cfnLabelProps{ name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnOutcome ¶
type CfnOutcome interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the outcome. AttrArn() *string // Timestamp of when outcome was created. AttrCreatedTime() *string // Timestamp of when outcome was last updated. AttrLastUpdatedTime() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // The outcome description. Description() *string SetDescription(val *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. // Experimental. LogicalId() *string // The outcome name. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::FraudDetector::Outcome`.
Creates or updates an outcome.
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" cfnOutcome := awscdk.Aws_frauddetector.NewCfnOutcome(this, jsii.String("MyCfnOutcome"), &cfnOutcomeProps{ name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnOutcome ¶
func NewCfnOutcome(scope awscdk.Construct, id *string, props *CfnOutcomeProps) CfnOutcome
Create a new `AWS::FraudDetector::Outcome`.
type CfnOutcomeProps ¶
type CfnOutcomeProps struct { // The outcome name. Name *string `field:"required" json:"name" yaml:"name"` // The outcome description. Description *string `field:"optional" json:"description" yaml:"description"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnOutcome`.
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" cfnOutcomeProps := &cfnOutcomeProps{ name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnVariable ¶
type CfnVariable interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the variable. AttrArn() *string // Timestamp of when variable was created. AttrCreatedTime() *string // Timestamp of when variable was last updated. AttrLastUpdatedTime() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // The data source of the variable. // // Valid values: `EVENT | EXTERNAL_MODEL_SCORE` // // When defining a variable within a detector, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true. If the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource. DataSource() *string SetDataSource(val *string) // The data type of the variable. // // Valid data types: `STRING | INTEGER | BOOLEAN | FLOAT`. DataType() *string SetDataType(val *string) // The default value of the variable. DefaultValue() *string SetDefaultValue(val *string) // The description of the variable. Description() *string SetDescription(val *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. // Experimental. LogicalId() *string // The name of the variable. // // Pattern: `^[0-9a-z_-]+$`. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // The type of the variable. For more information see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) . // // Valid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT`. VariableType() *string SetVariableType(val *string) // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::FraudDetector::Variable`.
Manages a variable.
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" cfnVariable := awscdk.Aws_frauddetector.NewCfnVariable(this, jsii.String("MyCfnVariable"), &cfnVariableProps{ dataSource: jsii.String("dataSource"), dataType: jsii.String("dataType"), defaultValue: jsii.String("defaultValue"), name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, variableType: jsii.String("variableType"), })
func NewCfnVariable ¶
func NewCfnVariable(scope awscdk.Construct, id *string, props *CfnVariableProps) CfnVariable
Create a new `AWS::FraudDetector::Variable`.
type CfnVariableProps ¶
type CfnVariableProps struct { // The data source of the variable. // // Valid values: `EVENT | EXTERNAL_MODEL_SCORE` // // When defining a variable within a detector, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true. If the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource. DataSource *string `field:"required" json:"dataSource" yaml:"dataSource"` // The data type of the variable. // // Valid data types: `STRING | INTEGER | BOOLEAN | FLOAT`. DataType *string `field:"required" json:"dataType" yaml:"dataType"` // The default value of the variable. DefaultValue *string `field:"required" json:"defaultValue" yaml:"defaultValue"` // The name of the variable. // // Pattern: `^[0-9a-z_-]+$`. Name *string `field:"required" json:"name" yaml:"name"` // The description of the variable. Description *string `field:"optional" json:"description" yaml:"description"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The type of the variable. For more information see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) . // // Valid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT`. VariableType *string `field:"optional" json:"variableType" yaml:"variableType"` }
Properties for defining a `CfnVariable`.
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" cfnVariableProps := &cfnVariableProps{ dataSource: jsii.String("dataSource"), dataType: jsii.String("dataType"), defaultValue: jsii.String("defaultValue"), name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, variableType: jsii.String("variableType"), }
Source Files ¶
- awsfrauddetector.go
- awsfrauddetector_CfnDetector.go
- awsfrauddetector_CfnDetectorProps.go
- awsfrauddetector_CfnDetector_EntityTypeProperty.go
- awsfrauddetector_CfnDetector_EventTypeProperty.go
- awsfrauddetector_CfnDetector_EventVariableProperty.go
- awsfrauddetector_CfnDetector_LabelProperty.go
- awsfrauddetector_CfnDetector_ModelProperty.go
- awsfrauddetector_CfnDetector_OutcomeProperty.go
- awsfrauddetector_CfnDetector_RuleProperty.go
- awsfrauddetector_CfnDetector__runtime_type_checks.go
- awsfrauddetector_CfnEntityType.go
- awsfrauddetector_CfnEntityTypeProps.go
- awsfrauddetector_CfnEntityType__runtime_type_checks.go
- awsfrauddetector_CfnEventType.go
- awsfrauddetector_CfnEventTypeProps.go
- awsfrauddetector_CfnEventType_EntityTypeProperty.go
- awsfrauddetector_CfnEventType_EventVariableProperty.go
- awsfrauddetector_CfnEventType_LabelProperty.go
- awsfrauddetector_CfnEventType__runtime_type_checks.go
- awsfrauddetector_CfnLabel.go
- awsfrauddetector_CfnLabelProps.go
- awsfrauddetector_CfnLabel__runtime_type_checks.go
- awsfrauddetector_CfnOutcome.go
- awsfrauddetector_CfnOutcomeProps.go
- awsfrauddetector_CfnOutcome__runtime_type_checks.go
- awsfrauddetector_CfnVariable.go
- awsfrauddetector_CfnVariableProps.go
- awsfrauddetector_CfnVariable__runtime_type_checks.go