Class: AWSCDK::StepFunctions::CfnStateMachine::S3LocationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
step_functions/cfn_state_machine.rb

Overview

Defines the S3 bucket location where a state machine definition is stored.

The state machine definition must be a JSON or YAML file.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket:, key:, version: nil) ⇒ S3LocationProperty

Returns a new instance of S3LocationProperty.

Parameters:

  • bucket (String) —

    The name of the S3 bucket where the state machine definition JSON or YAML file is stored.

  • key (String) —

    The name of the state machine definition file (Amazon S3 object name).

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

    For versioning-enabled buckets, a specific version of the state machine definition.



879
880
881
882
883
884
885
886
 
# File 'step_functions/cfn_state_machine.rb', line 879

def initialize(bucket:, key:, version: nil)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucket")
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless @version.nil?
end

Instance Attribute Details

#bucket ⇒ String (readonly)

The name of the S3 bucket where the state machine definition JSON or YAML file is stored.

Returns:

  • (String)

See Also:



892
893
894
 
# File 'step_functions/cfn_state_machine.rb', line 892

def bucket
  @bucket
end

#key ⇒ String (readonly)

The name of the state machine definition file (Amazon S3 object name).

Returns:

  • (String)

See Also:



897
898
899
 
# File 'step_functions/cfn_state_machine.rb', line 897

def key
  @key
end

#version ⇒ String? (readonly)

For versioning-enabled buckets, a specific version of the state machine definition.

Returns:

  • (String, nil)

See Also:



902
903
904
 
# File 'step_functions/cfn_state_machine.rb', line 902

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



904
905
906
907
908
909
910
 
# File 'step_functions/cfn_state_machine.rb', line 904

def self.jsii_properties
  {
    :bucket => "bucket",
    :key => "key",
    :version => "version",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



912
913
914
915
916
917
918
919
920
 
# File 'step_functions/cfn_state_machine.rb', line 912

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "key" => @key,
    "version" => @version,
  })
  result.compact
end