View a markdown version of this page

AWS::Batch::JobDefinition S3FilesVolumeConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Batch::JobDefinition S3FilesVolumeConfiguration

This is used when you're using an S3Files file system for job storage.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AccessPointArn" : String,
  "FileSystemArn" : String,
  "RootDirectory" : String,
  "TransitEncryptionPort" : Integer
}

YAML

  AccessPointArn: String
  FileSystemArn: String
  RootDirectory: String
  TransitEncryptionPort: Integer

Properties

AccessPointArn

The Amazon Resource Name (ARN) of the S3Files access point to use.

Required: No

Type: String

Update requires: No interruption

FileSystemArn

The Amazon Resource Name (ARN) of the S3Files file system to use.

Required: Yes

Type: String

Update requires: No interruption

RootDirectory

The directory within the S3Files file system to mount as the root directory.

Required: No

Type: String

Update requires: No interruption

TransitEncryptionPort

The port to use when sending encrypted data between the Amazon ECS host and the S3Files file system server.

Required: No

Type: Integer

Update requires: No interruption