package awscdkbatchalpha import ( _init_ "github.com/aws/aws-cdk-go/awscdkbatchalpha/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/awsec2" "github.com/aws/aws-cdk-go/awscdkbatchalpha/v2/internal" "github.com/aws/constructs-go/constructs/v10" ) // A JobDefinition that uses Ecs orchestration to run multiple containers. // // Example: // import "github.com/aws/aws-cdk-go/awscdk" // // multiNodeJob := batch.NewMultiNodeJobDefinition(this, jsii.String("JobDefinition"), &MultiNodeJobDefinitionProps{ // InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_R4, ec2.InstanceSize_LARGE), // Containers: []multiNodeContainer{ // &multiNodeContainer{ // Container: batch.NewEcsEc2ContainerDefinition(this, jsii.String("mainMPIContainer"), &EcsEc2ContainerDefinitionProps{ // Image: ecs.ContainerImage_FromRegistry(jsii.String("yourregsitry.com/yourMPIImage:latest")), // Cpu: jsii.Number(256), // Memory: cdk.Size_Mebibytes(jsii.Number(2048)), // }), // StartNode: jsii.Number(0), // EndNode: jsii.Number(5), // }, // }, // }) // // convenience method // multiNodeJob.AddContainer(&multiNodeContainer{ // StartNode: jsii.Number(6), // EndNode: jsii.Number(10), // Container: batch.NewEcsEc2ContainerDefinition(this, jsii.String("multiContainer"), &EcsEc2ContainerDefinitionProps{ // Image: ecs.ContainerImage_*FromRegistry(jsii.String("amazon/amazon-ecs-sample")), // Cpu: jsii.Number(256), // Memory: cdk.Size_*Mebibytes(jsii.Number(2048)), // }), // }) // // Experimental. type MultiNodeJobDefinition interface { awscdk.Resource IJobDefinition // The containers that this multinode job will run. // Experimental. Containers() *[]*MultiNodeContainer // 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. // Experimental. Env() *awscdk.ResourceEnvironment // The instance type that this job definition will run. // Experimental. InstanceType() awsec2.InstanceType // The ARN of this job definition. // Experimental. JobDefinitionArn() *string // The name of this job definition. // Experimental. JobDefinitionName() *string // The index of the main node in this job. // // The main node is responsible for orchestration. // Experimental. MainNode() *float64 // The tree node. // Experimental. Node() constructs.Node // The default parameters passed to the container These parameters can be referenced in the `command` that you give to the container. // Experimental. Parameters() *map[string]interface{} // 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. // Experimental. PhysicalName() *string // Whether to propogate tags from the JobDefinition to the ECS task that Batch spawns. // Experimental. PropagateTags() *bool // The number of times to retry a job. // // The job is retried on failure the same number of attempts as the value. // Experimental. RetryAttempts() *float64 // Defines the retry behavior for this job. // Experimental. RetryStrategies() *[]RetryStrategy // The priority of this Job. // // Only used in Fairshare Scheduling // to decide which job to run first when there are multiple jobs // with the same share identifier. // Experimental. SchedulingPriority() *float64 // The stack in which this resource is defined. // Experimental. Stack() awscdk.Stack // The timeout time for jobs that are submitted with this job definition. // // After the amount of time you specify passes, // Batch terminates your jobs if they aren't finished. // Experimental. Timeout() awscdk.Duration // Add a container to this multinode job. // Experimental. AddContainer(container *MultiNodeContainer) // Add a RetryStrategy to this JobDefinition. // Experimental. AddRetryStrategy(strategy RetryStrategy) // 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`). // Experimental. ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Experimental. 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`. // Experimental. 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. // Experimental. GetResourceNameAttribute(nameAttr *string) *string // Returns a string representation of this construct. // Experimental. ToString() *string } // The jsii proxy struct for MultiNodeJobDefinition type jsiiProxy_MultiNodeJobDefinition struct { internal.Type__awscdkResource jsiiProxy_IJobDefinition } func (j *jsiiProxy_MultiNodeJobDefinition) Containers() *[]*MultiNodeContainer { var returns *[]*MultiNodeContainer _jsii_.Get( j, "containers", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) InstanceType() awsec2.InstanceType { var returns awsec2.InstanceType _jsii_.Get( j, "instanceType", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) JobDefinitionArn() *string { var returns *string _jsii_.Get( j, "jobDefinitionArn", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) JobDefinitionName() *string { var returns *string _jsii_.Get( j, "jobDefinitionName", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) MainNode() *float64 { var returns *float64 _jsii_.Get( j, "mainNode", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) Parameters() *map[string]interface{} { var returns *map[string]interface{} _jsii_.Get( j, "parameters", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) PropagateTags() *bool { var returns *bool _jsii_.Get( j, "propagateTags", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) RetryAttempts() *float64 { var returns *float64 _jsii_.Get( j, "retryAttempts", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) RetryStrategies() *[]RetryStrategy { var returns *[]RetryStrategy _jsii_.Get( j, "retryStrategies", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) SchedulingPriority() *float64 { var returns *float64 _jsii_.Get( j, "schedulingPriority", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_MultiNodeJobDefinition) Timeout() awscdk.Duration { var returns awscdk.Duration _jsii_.Get( j, "timeout", &returns, ) return returns } // Experimental. func NewMultiNodeJobDefinition(scope constructs.Construct, id *string, props *MultiNodeJobDefinitionProps) MultiNodeJobDefinition { _init_.Initialize() if err := validateNewMultiNodeJobDefinitionParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_MultiNodeJobDefinition{} _jsii_.Create( "@aws-cdk/aws-batch-alpha.MultiNodeJobDefinition", []interface{}{scope, id, props}, &j, ) return &j } // Experimental. func NewMultiNodeJobDefinition_Override(m MultiNodeJobDefinition, scope constructs.Construct, id *string, props *MultiNodeJobDefinitionProps) { _init_.Initialize() _jsii_.Create( "@aws-cdk/aws-batch-alpha.MultiNodeJobDefinition", []interface{}{scope, id, props}, m, ) } // refer to an existing JobDefinition by its arn. // Experimental. func MultiNodeJobDefinition_FromJobDefinitionArn(scope constructs.Construct, id *string, jobDefinitionArn *string) IJobDefinition { _init_.Initialize() if err := validateMultiNodeJobDefinition_FromJobDefinitionArnParameters(scope, id, jobDefinitionArn); err != nil { panic(err) } var returns IJobDefinition _jsii_.StaticInvoke( "@aws-cdk/aws-batch-alpha.MultiNodeJobDefinition", "fromJobDefinitionArn", []interface{}{scope, id, jobDefinitionArn}, &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`. // Experimental. func MultiNodeJobDefinition_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateMultiNodeJobDefinition_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-batch-alpha.MultiNodeJobDefinition", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. // Experimental. func MultiNodeJobDefinition_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateMultiNodeJobDefinition_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-batch-alpha.MultiNodeJobDefinition", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. // Experimental. func MultiNodeJobDefinition_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateMultiNodeJobDefinition_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-batch-alpha.MultiNodeJobDefinition", "isResource", []interface{}{construct}, &returns, ) return returns } func (m *jsiiProxy_MultiNodeJobDefinition) AddContainer(container *MultiNodeContainer) { if err := m.validateAddContainerParameters(container); err != nil { panic(err) } _jsii_.InvokeVoid( m, "addContainer", []interface{}{container}, ) } func (m *jsiiProxy_MultiNodeJobDefinition) AddRetryStrategy(strategy RetryStrategy) { if err := m.validateAddRetryStrategyParameters(strategy); err != nil { panic(err) } _jsii_.InvokeVoid( m, "addRetryStrategy", []interface{}{strategy}, ) } func (m *jsiiProxy_MultiNodeJobDefinition) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := m.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( m, "applyRemovalPolicy", []interface{}{policy}, ) } func (m *jsiiProxy_MultiNodeJobDefinition) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( m, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (m *jsiiProxy_MultiNodeJobDefinition) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := m.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( m, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (m *jsiiProxy_MultiNodeJobDefinition) GetResourceNameAttribute(nameAttr *string) *string { if err := m.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( m, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (m *jsiiProxy_MultiNodeJobDefinition) ToString() *string { var returns *string _jsii_.Invoke( m, "toString", nil, // no parameters &returns, ) return returns }