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/awscdkbatchalpha/v2/internal" "github.com/aws/constructs-go/constructs/v10" ) // A JobDefinition that uses Eks orchestration. // // Example: // import cdk "github.com/aws/aws-cdk-go/awscdk" // // jobDefn := batch.NewEksJobDefinition(this, jsii.String("eksf2"), &EksJobDefinitionProps{ // Container: batch.NewEksContainerDefinition(this, jsii.String("container"), &EksContainerDefinitionProps{ // Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")), // Volumes: []eksVolume{ // batch.*eksVolume_EmptyDir(&EmptyDirVolumeOptions{ // Name: jsii.String("myEmptyDirVolume"), // MountPath: jsii.String("/mount/path"), // Medium: batch.EmptyDirMediumType_MEMORY, // Readonly: jsii.Boolean(true), // SizeLimit: cdk.Size_Mebibytes(jsii.Number(2048)), // }), // }, // }), // }) // // Experimental. type EksJobDefinition interface { awscdk.Resource IEksJobDefinition IJobDefinition // The container this Job Definition will run. // Experimental. Container() EksContainerDefinition // The DNS Policy of the pod used by this Job Definition. // Experimental. DnsPolicy() DnsPolicy // 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 ARN of this job definition. // Experimental. JobDefinitionArn() *string // The name of this job definition. // Experimental. JobDefinitionName() *string // 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 // 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 name of the service account that's used to run the container. // // service accounts are Kubernetes method of identification and authentication, // roughly analogous to IAM users. // Experimental. ServiceAccount() *string // 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 // If specified, the Pod used by this Job Definition will use the host's network IP address. // // Otherwise, the Kubernetes pod networking model is enabled. // Most AWS Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. // Experimental. UseHostNetwork() *bool // 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 EksJobDefinition type jsiiProxy_EksJobDefinition struct { internal.Type__awscdkResource jsiiProxy_IEksJobDefinition jsiiProxy_IJobDefinition } func (j *jsiiProxy_EksJobDefinition) Container() EksContainerDefinition { var returns EksContainerDefinition _jsii_.Get( j, "container", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) DnsPolicy() DnsPolicy { var returns DnsPolicy _jsii_.Get( j, "dnsPolicy", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) JobDefinitionArn() *string { var returns *string _jsii_.Get( j, "jobDefinitionArn", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) JobDefinitionName() *string { var returns *string _jsii_.Get( j, "jobDefinitionName", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) Parameters() *map[string]interface{} { var returns *map[string]interface{} _jsii_.Get( j, "parameters", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) RetryAttempts() *float64 { var returns *float64 _jsii_.Get( j, "retryAttempts", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) RetryStrategies() *[]RetryStrategy { var returns *[]RetryStrategy _jsii_.Get( j, "retryStrategies", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) SchedulingPriority() *float64 { var returns *float64 _jsii_.Get( j, "schedulingPriority", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) ServiceAccount() *string { var returns *string _jsii_.Get( j, "serviceAccount", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) Timeout() awscdk.Duration { var returns awscdk.Duration _jsii_.Get( j, "timeout", &returns, ) return returns } func (j *jsiiProxy_EksJobDefinition) UseHostNetwork() *bool { var returns *bool _jsii_.Get( j, "useHostNetwork", &returns, ) return returns } // Experimental. func NewEksJobDefinition(scope constructs.Construct, id *string, props *EksJobDefinitionProps) EksJobDefinition { _init_.Initialize() if err := validateNewEksJobDefinitionParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_EksJobDefinition{} _jsii_.Create( "@aws-cdk/aws-batch-alpha.EksJobDefinition", []interface{}{scope, id, props}, &j, ) return &j } // Experimental. func NewEksJobDefinition_Override(e EksJobDefinition, scope constructs.Construct, id *string, props *EksJobDefinitionProps) { _init_.Initialize() _jsii_.Create( "@aws-cdk/aws-batch-alpha.EksJobDefinition", []interface{}{scope, id, props}, e, ) } // Import an EksJobDefinition by its arn. // Experimental. func EksJobDefinition_FromEksJobDefinitionArn(scope constructs.Construct, id *string, eksJobDefinitionArn *string) IEksJobDefinition { _init_.Initialize() if err := validateEksJobDefinition_FromEksJobDefinitionArnParameters(scope, id, eksJobDefinitionArn); err != nil { panic(err) } var returns IEksJobDefinition _jsii_.StaticInvoke( "@aws-cdk/aws-batch-alpha.EksJobDefinition", "fromEksJobDefinitionArn", []interface{}{scope, id, eksJobDefinitionArn}, &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 EksJobDefinition_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateEksJobDefinition_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-batch-alpha.EksJobDefinition", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. // Experimental. func EksJobDefinition_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateEksJobDefinition_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-batch-alpha.EksJobDefinition", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. // Experimental. func EksJobDefinition_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateEksJobDefinition_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-batch-alpha.EksJobDefinition", "isResource", []interface{}{construct}, &returns, ) return returns } func (e *jsiiProxy_EksJobDefinition) AddRetryStrategy(strategy RetryStrategy) { if err := e.validateAddRetryStrategyParameters(strategy); err != nil { panic(err) } _jsii_.InvokeVoid( e, "addRetryStrategy", []interface{}{strategy}, ) } func (e *jsiiProxy_EksJobDefinition) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := e.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( e, "applyRemovalPolicy", []interface{}{policy}, ) } func (e *jsiiProxy_EksJobDefinition) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( e, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (e *jsiiProxy_EksJobDefinition) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := e.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( e, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (e *jsiiProxy_EksJobDefinition) GetResourceNameAttribute(nameAttr *string) *string { if err := e.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( e, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (e *jsiiProxy_EksJobDefinition) ToString() *string { var returns *string _jsii_.Invoke( e, "toString", nil, // no parameters &returns, ) return returns }