package awsstepfunctions import ( _init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/aws-cdk-go/awscdk/v2" "github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch" "github.com/aws/aws-cdk-go/awscdk/v2/awsiam" "github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions/internal" "github.com/aws/constructs-go/constructs/v10" ) // Define a StepFunctions State Machine. // // Example: // import "github.com/aws/aws-cdk-go/awscdk" // // // pipeline := codepipeline.NewPipeline(this, jsii.String("MyPipeline")) // inputArtifact := codepipeline.NewArtifact() // startState := stepfunctions.NewPass(this, jsii.String("StartState")) // simpleStateMachine := stepfunctions.NewStateMachine(this, jsii.String("SimpleStateMachine"), &StateMachineProps{ // Definition: startState, // }) // stepFunctionAction := codepipeline_actions.NewStepFunctionInvokeAction(&StepFunctionsInvokeActionProps{ // ActionName: jsii.String("Invoke"), // StateMachine: simpleStateMachine, // StateMachineInput: codepipeline_actions.StateMachineInput_FilePath(inputArtifact.AtPath(jsii.String("assets/input.json"))), // }) // pipeline.AddStage(&StageOptions{ // StageName: jsii.String("StepFunctions"), // Actions: []iAction{ // stepFunctionAction, // }, // }) // type StateMachine interface { awscdk.Resource IStateMachine // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *awscdk.ResourceEnvironment // The principal this state machine is running as. GrantPrincipal() awsiam.IPrincipal // The tree node. Node() constructs.Node // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. PhysicalName() *string // Execution role of this state machine. Role() awsiam.IRole // The stack in which this resource is defined. Stack() awscdk.Stack // The ARN of the state machine. StateMachineArn() *string // The name of the state machine. StateMachineName() *string // Identifier for the state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration. StateMachineRevisionId() *string // Type of the state machine. StateMachineType() StateMachineType // Add the given statement to the role's policy. AddToRolePolicy(statement awsiam.PolicyStatement) // Apply the given removal policy to this resource. // // 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`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. GetResourceNameAttribute(nameAttr *string) *string // Grant the given identity custom permissions. Grant(identity awsiam.IGrantable, actions ...*string) awsiam.Grant // Grant the given identity permissions on all executions of the state machine. GrantExecution(identity awsiam.IGrantable, actions ...*string) awsiam.Grant // Grant the given identity permissions to read results from state machine. GrantRead(identity awsiam.IGrantable) awsiam.Grant // Grant the given identity permissions to start an execution of this state machine. GrantStartExecution(identity awsiam.IGrantable) awsiam.Grant // Grant the given identity permissions to start a synchronous execution of this state machine. GrantStartSyncExecution(identity awsiam.IGrantable) awsiam.Grant // Grant the given identity task response permissions on a state machine. GrantTaskResponse(identity awsiam.IGrantable) awsiam.Grant // Return the given named metric for this State Machine's executions. Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of executions that were aborted. MetricAborted(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of executions that failed. MetricFailed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of executions that were started. MetricStarted(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of executions that succeeded. MetricSucceeded(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of executions that were throttled. MetricThrottled(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the interval, in milliseconds, between the time the execution starts and the time it closes. MetricTime(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of executions that timed out. MetricTimedOut(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Returns a string representation of this construct. ToString() *string } // The jsii proxy struct for StateMachine type jsiiProxy_StateMachine struct { internal.Type__awscdkResource jsiiProxy_IStateMachine } func (j *jsiiProxy_StateMachine) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_StateMachine) GrantPrincipal() awsiam.IPrincipal { var returns awsiam.IPrincipal _jsii_.Get( j, "grantPrincipal", &returns, ) return returns } func (j *jsiiProxy_StateMachine) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_StateMachine) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_StateMachine) Role() awsiam.IRole { var returns awsiam.IRole _jsii_.Get( j, "role", &returns, ) return returns } func (j *jsiiProxy_StateMachine) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_StateMachine) StateMachineArn() *string { var returns *string _jsii_.Get( j, "stateMachineArn", &returns, ) return returns } func (j *jsiiProxy_StateMachine) StateMachineName() *string { var returns *string _jsii_.Get( j, "stateMachineName", &returns, ) return returns } func (j *jsiiProxy_StateMachine) StateMachineRevisionId() *string { var returns *string _jsii_.Get( j, "stateMachineRevisionId", &returns, ) return returns } func (j *jsiiProxy_StateMachine) StateMachineType() StateMachineType { var returns StateMachineType _jsii_.Get( j, "stateMachineType", &returns, ) return returns } func NewStateMachine(scope constructs.Construct, id *string, props *StateMachineProps) StateMachine { _init_.Initialize() if err := validateNewStateMachineParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_StateMachine{} _jsii_.Create( "aws-cdk-lib.aws_stepfunctions.StateMachine", []interface{}{scope, id, props}, &j, ) return &j } func NewStateMachine_Override(s StateMachine, scope constructs.Construct, id *string, props *StateMachineProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.aws_stepfunctions.StateMachine", []interface{}{scope, id, props}, s, ) } // Import a state machine. func StateMachine_FromStateMachineArn(scope constructs.Construct, id *string, stateMachineArn *string) IStateMachine { _init_.Initialize() if err := validateStateMachine_FromStateMachineArnParameters(scope, id, stateMachineArn); err != nil { panic(err) } var returns IStateMachine _jsii_.StaticInvoke( "aws-cdk-lib.aws_stepfunctions.StateMachine", "fromStateMachineArn", []interface{}{scope, id, stateMachineArn}, &returns, ) return returns } // Import a state machine via resource name. func StateMachine_FromStateMachineName(scope constructs.Construct, id *string, stateMachineName *string) IStateMachine { _init_.Initialize() if err := validateStateMachine_FromStateMachineNameParameters(scope, id, stateMachineName); err != nil { panic(err) } var returns IStateMachine _jsii_.StaticInvoke( "aws-cdk-lib.aws_stepfunctions.StateMachine", "fromStateMachineName", []interface{}{scope, id, stateMachineName}, &returns, ) return returns } // Checks if `x` is a construct. // // Use this method instead of `instanceof` to properly detect `Construct` // instances, even when the construct library is symlinked. // // Explanation: in JavaScript, multiple copies of the `constructs` library on // disk are seen as independent, completely different libraries. As a // consequence, the class `Construct` in each copy of the `constructs` library // is seen as a different class, and an instance of one class will not test as // `instanceof` the other class. `npm install` will not create installations // like this, but users may manually symlink construct libraries together or // use a monorepo tool: in those cases, multiple copies of the `constructs` // library can be accidentally installed, and `instanceof` will behave // unpredictably. It is safest to avoid using `instanceof`, and using // this type-testing method instead. // // Returns: true if `x` is an object created from a class which extends `Construct`. func StateMachine_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateStateMachine_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_stepfunctions.StateMachine", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. func StateMachine_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateStateMachine_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_stepfunctions.StateMachine", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. func StateMachine_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateStateMachine_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_stepfunctions.StateMachine", "isResource", []interface{}{construct}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) AddToRolePolicy(statement awsiam.PolicyStatement) { if err := s.validateAddToRolePolicyParameters(statement); err != nil { panic(err) } _jsii_.InvokeVoid( s, "addToRolePolicy", []interface{}{statement}, ) } func (s *jsiiProxy_StateMachine) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := s.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( s, "applyRemovalPolicy", []interface{}{policy}, ) } func (s *jsiiProxy_StateMachine) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( s, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (s *jsiiProxy_StateMachine) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := s.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) GetResourceNameAttribute(nameAttr *string) *string { if err := s.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) Grant(identity awsiam.IGrantable, actions ...*string) awsiam.Grant { if err := s.validateGrantParameters(identity); err != nil { panic(err) } args := []interface{}{identity} for _, a := range actions { args = append(args, a) } var returns awsiam.Grant _jsii_.Invoke( s, "grant", args, &returns, ) return returns } func (s *jsiiProxy_StateMachine) GrantExecution(identity awsiam.IGrantable, actions ...*string) awsiam.Grant { if err := s.validateGrantExecutionParameters(identity); err != nil { panic(err) } args := []interface{}{identity} for _, a := range actions { args = append(args, a) } var returns awsiam.Grant _jsii_.Invoke( s, "grantExecution", args, &returns, ) return returns } func (s *jsiiProxy_StateMachine) GrantRead(identity awsiam.IGrantable) awsiam.Grant { if err := s.validateGrantReadParameters(identity); err != nil { panic(err) } var returns awsiam.Grant _jsii_.Invoke( s, "grantRead", []interface{}{identity}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) GrantStartExecution(identity awsiam.IGrantable) awsiam.Grant { if err := s.validateGrantStartExecutionParameters(identity); err != nil { panic(err) } var returns awsiam.Grant _jsii_.Invoke( s, "grantStartExecution", []interface{}{identity}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) GrantStartSyncExecution(identity awsiam.IGrantable) awsiam.Grant { if err := s.validateGrantStartSyncExecutionParameters(identity); err != nil { panic(err) } var returns awsiam.Grant _jsii_.Invoke( s, "grantStartSyncExecution", []interface{}{identity}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) GrantTaskResponse(identity awsiam.IGrantable) awsiam.Grant { if err := s.validateGrantTaskResponseParameters(identity); err != nil { panic(err) } var returns awsiam.Grant _jsii_.Invoke( s, "grantTaskResponse", []interface{}{identity}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricParameters(metricName, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metric", []interface{}{metricName, props}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) MetricAborted(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricAbortedParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricAborted", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) MetricFailed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricFailedParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricFailed", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) MetricStarted(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricStartedParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricStarted", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) MetricSucceeded(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricSucceededParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricSucceeded", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) MetricThrottled(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricThrottledParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricThrottled", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) MetricTime(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricTimeParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricTime", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) MetricTimedOut(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricTimedOutParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricTimedOut", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_StateMachine) ToString() *string { var returns *string _jsii_.Invoke( s, "toString", nil, // no parameters &returns, ) return returns }