Class: AWSCDK::FraudDetector::CfnDetector::EventVariableProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
fraud_detector/cfn_detector.rb

Overview

The event type variable for the detector.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn: nil, created_time: nil, data_source: nil, data_type: nil, default_value: nil, description: nil, inline: nil, last_updated_time: nil, name: nil, tags: nil, variable_type: nil) ⇒ EventVariableProperty

Returns a new instance of EventVariableProperty.

Parameters:

  • arn (String, nil) (defaults to: nil) —

    The event variable ARN.

  • created_time (String, nil) (defaults to: nil) —

    Timestamp for when the event variable was created.

  • data_source (String, nil) (defaults to: nil) —

    The data source of the event variable.

  • data_type (String, nil) (defaults to: nil) —

    The data type of the event variable.

  • default_value (String, nil) (defaults to: nil) —

    The default value of the event variable.

  • description (String, nil) (defaults to: nil) —

    The description of the event variable.

  • inline (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack.

  • last_updated_time (String, nil) (defaults to: nil) —

    Timestamp for when the event variable was last updated.

  • name (String, nil) (defaults to: nil) —

    The name of the event variable.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.

  • variable_type (String, nil) (defaults to: nil) —

    The type of event variable.



895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'fraud_detector/cfn_detector.rb', line 895

def initialize(arn: nil, created_time: nil, data_source: nil, data_type: nil, default_value: nil, description: nil, inline: nil, last_updated_time: nil, name: nil, tags: nil, variable_type: nil)
  @arn = arn
  Jsii::Type.check_type(@arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn") unless @arn.nil?
  @created_time = created_time
  Jsii::Type.check_type(@created_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "createdTime") unless @created_time.nil?
  @data_source = data_source
  Jsii::Type.check_type(@data_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataSource") unless @data_source.nil?
  @data_type = data_type
  Jsii::Type.check_type(@data_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataType") unless @data_type.nil?
  @default_value = default_value
  Jsii::Type.check_type(@default_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultValue") unless @default_value.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @inline = inline
  Jsii::Type.check_type(@inline, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "inline") unless @inline.nil?
  @last_updated_time = last_updated_time
  Jsii::Type.check_type(@last_updated_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lastUpdatedTime") unless @last_updated_time.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @variable_type = variable_type
  Jsii::Type.check_type(@variable_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "variableType") unless @variable_type.nil?
end

Instance Attribute Details

#arn ⇒ String? (readonly)

The event variable ARN.

Returns:

  • (String, nil)

See Also:



924
925
926
 
# File 'fraud_detector/cfn_detector.rb', line 924

def arn
  @arn
end

#created_time ⇒ String? (readonly)

Timestamp for when the event variable was created.

Returns:

  • (String, nil)

See Also:



929
930
931
 
# File 'fraud_detector/cfn_detector.rb', line 929

def created_time
  @created_time
end

#data_source ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



938
939
940
 
# File 'fraud_detector/cfn_detector.rb', line 938

def data_source
  @data_source
end

#data_type ⇒ String? (readonly)

The data type of the event variable.

Valid values: STRING | INTEGER | BOOLEAN | FLOAT

Returns:

  • (String, nil)

See Also:



945
946
947
 
# File 'fraud_detector/cfn_detector.rb', line 945

def data_type
  @data_type
end

#default_value ⇒ String? (readonly)

The default value of the event variable.

This is required if you are providing the details of your variables instead of the ARN.

Returns:

  • (String, nil)

See Also:



952
953
954
 
# File 'fraud_detector/cfn_detector.rb', line 952

def default_value
  @default_value
end

#description ⇒ String? (readonly)

The description of the event variable.

Returns:

  • (String, nil)

See Also:



957
958
959
 
# File 'fraud_detector/cfn_detector.rb', line 957

def description
  @description
end

#inline ⇒ Boolean, ... (readonly)

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.

Returns:

See Also:



966
967
968
 
# File 'fraud_detector/cfn_detector.rb', line 966

def inline
  @inline
end

#last_updated_time ⇒ String? (readonly)

Timestamp for when the event variable was last updated.

Returns:

  • (String, nil)

See Also:



971
972
973
 
# File 'fraud_detector/cfn_detector.rb', line 971

def last_updated_time
  @last_updated_time
end

#name ⇒ String? (readonly)

The name of the event variable.

Returns:

  • (String, nil)

See Also:



976
977
978
 
# File 'fraud_detector/cfn_detector.rb', line 976

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

See Also:



983
984
985
 
# File 'fraud_detector/cfn_detector.rb', line 983

def tags
  @tags
end

#variable_type ⇒ String? (readonly)

The type of event variable.

For more information, see Variable types .

Returns:

  • (String, nil)

See Also:



990
991
992
 
# File 'fraud_detector/cfn_detector.rb', line 990

def variable_type
  @variable_type
end

Class Method Details

.jsii_properties ⇒ Object 



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'fraud_detector/cfn_detector.rb', line 992

def self.jsii_properties
  {
    :arn => "arn",
    :created_time => "createdTime",
    :data_source => "dataSource",
    :data_type => "dataType",
    :default_value => "defaultValue",
    :description => "description",
    :inline => "inline",
    :last_updated_time => "lastUpdatedTime",
    :name => "name",
    :tags => "tags",
    :variable_type => "variableType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'fraud_detector/cfn_detector.rb', line 1008

def to_jsii
  result = {}
  result.merge!({
    "arn" => @arn,
    "createdTime" => @created_time,
    "dataSource" => @data_source,
    "dataType" => @data_type,
    "defaultValue" => @default_value,
    "description" => @description,
    "inline" => @inline,
    "lastUpdatedTime" => @last_updated_time,
    "name" => @name,
    "tags" => @tags,
    "variableType" => @variable_type,
  })
  result.compact
end