Class: AWSCDK::StepFunctions::StateMachineGrants

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

Overview

Collection of grant methods for a IStateMachineRef.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ StateMachineGrants

Returns a new instance of StateMachineGrants.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'step_functions/state_machine_grants.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_stepfunctions.StateMachineGrants does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.from_state_machine(resource) ⇒ AWSCDK::StepFunctions::StateMachineGrants

Creates grants for StateMachineGrants.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::StateMachineGrants) 


29
30
31
32
 
# File 'step_functions/state_machine_grants.rb', line 29

def self.from_state_machine(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zdGVwZnVuY3Rpb25zLklTdGF0ZU1hY2hpbmVSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.StateMachineGrants", "fromStateMachine", [resource])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'step_functions/state_machine_grants.rb', line 12

def self.jsii_overridable_methods
  {
    :resource => { kind: :property, name: "resource", is_optional: false },
    :actions => { kind: :method, name: "actions", is_optional: false },
    :execution => { kind: :method, name: "execution", is_optional: false },
    :read => { kind: :method, name: "read", is_optional: false },
    :redrive_execution => { kind: :method, name: "redriveExecution", is_optional: false },
    :start_execution => { kind: :method, name: "startExecution", is_optional: false },
    :start_sync_execution => { kind: :method, name: "startSyncExecution", is_optional: false },
    :task_response => { kind: :method, name: "taskResponse", is_optional: false },
  }
end

Instance Method Details

#actions(identity, *actions) ⇒ AWSCDK::IAM::Grant

Grant the given identity custom permissions.

Parameters:

Returns:



44
45
46
47
48
49
50
 
# File 'step_functions/state_machine_grants.rb', line 44

def actions(identity, *actions)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("actions", [identity, *actions])
end

#execution(grantee, *actions) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to start an execution of this state machine.

Parameters:

Returns:



57
58
59
60
61
62
63
 
# File 'step_functions/state_machine_grants.rb', line 57

def execution(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("execution", [grantee, *actions])
end

#read(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to read results from state machine.

Parameters:

Returns:



69
70
71
72
 
# File 'step_functions/state_machine_grants.rb', line 69

def read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("read", [grantee])
end

#redrive_execution(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity permission to redrive the execution of the state machine.

Parameters:

Returns:



78
79
80
81
 
# File 'step_functions/state_machine_grants.rb', line 78

def redrive_execution(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("redriveExecution", [grantee])
end

#resource ⇒ AWSCDK::Interfaces::AWSStepfunctions::IStateMachineRef

Returns:



35
36
37
 
# File 'step_functions/state_machine_grants.rb', line 35

def resource()
  jsii_get_property("resource")
end

#start_execution(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to start an execution of this state machine.

Parameters:

Returns:



87
88
89
90
 
# File 'step_functions/state_machine_grants.rb', line 87

def start_execution(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("startExecution", [grantee])
end

#start_sync_execution(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to start a synchronous execution of this state machine.

Parameters:

Returns:



96
97
98
99
 
# File 'step_functions/state_machine_grants.rb', line 96

def start_sync_execution(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("startSyncExecution", [grantee])
end

#task_response(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity task response permissions on a state machine.

Parameters:

Returns:



105
106
107
108
 
# File 'step_functions/state_machine_grants.rb', line 105

def task_response(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("taskResponse", [grantee])
end