AWS Plugin Reference 6.2.x

    The XL Deploy AWS plugin enables XL Deploy to work with Amazon Web Services such as Elastic Compute Cloud (EC2) and Simple Storage Service (S3).

    This document contains information that is specific to this version of the plugin. For information about plugin features, refer to Introduction to the XL Deploy AWS plugin. For general information about provisioning, refer to Provisioning through XL Deploy.

    Requirements

    • XL Deploy 6.2.0 or later
    • User credentials for accessing Amazon Web Services (AWS)

    Release notes

    AWS plugin 6.2.0

    New features

    • [DEPL-10805] - Provision/deprovision an S3 bucket
    • [DEPL-10644] - Upload files to/delete files from an S3 bucket
    • [DEPL-10643] - Provision/deprovision an EBS volume
    • [DEPL-10777] - Add more configuration options when creating an EC2 instance
    • [DEPL-11073] - Add instanceName property for EC2 in AWS plugin
    • [DEPL-11035] - Attach network interfaces with an EC2 instance
    • [DEPL-11074] - Add call to reserve elastic IP in EC2

    Important: When specifying the name of a property or resource, use the format Name:xxx instead of Id. The name tag is used for to look up the resource.

    Bug fixes

    • [DEPL-9854] - BotoLoader scans the wrong directory for services

    Limitations

    The Elastic IP can be associated with non-VPC instances only.

    Breaking changes

    The securityGroup property of the aws.ec2.Instance configuration item (CI) type now accepts a list of strings. This allows you to specify more than one security group for an AWS EC2 instance. Also, the default value of this property has been removed.

    Deprecations

    The aws.ec2.Cloud CI type is deprecated and will be removed in the next release of the plugin.

    CI Reference

    Configuration Item Overview

    Deployables

    CI Description
    aws.ec2.EbsVolumeSpec Specification for an AWS EBS volume
    aws.ec2.InstanceSpec Specification for an AWS EC2 instance
    aws.ec2.NetworkInterfaceSpec Creates a network interface
    aws.s3.Archive Specification for an AWS S3 Archive
    aws.s3.BucketSpec Specification for an AWS S3 bucket
    aws.s3.File Specification for an AWS S3 File
    aws.s3.Folder Specification for an AWS S3 Folder

    Deployeds

    CI Description
    aws.ec2.EbsVolume AWS EBS volume
    aws.ec2.Instance AWS EC2 instance
    aws.ec2.NetworkInterface Creates a network interface
    aws.s3.Bucket AWS S3 bucket
    aws.s3.UploadedArchive AWS S3 File
    aws.s3.UploadedFile AWS S3 File
    aws.s3.UploadedFolder AWS S3 File

    Containers

    CI Description
    aws.Cloud AWS account
    aws.ec2.Cloud AWS EC2 account
    aws.s3.Bucket AWS S3 bucket

    Configuration Item Details

    aws.Cloud

    Type Hierarchy udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces udm.Container, udm.ConfigurationItem, udm.Taggable

    AWS account.

    Public Properties
     
     
    accessSecret : STRING
    The access secret to use when connecting to AWS.
     
     
    accesskey : STRING
    The access key to use when connecting to AWS.
     
     
    tags : SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.

    aws.ec2.Cloud

    Type Hierarchy aws.Cloud >> udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces udm.Container, udm.ConfigurationItem, udm.Taggable

    AWS EC2 account. This will be deprecated in the next release.

    Public Properties
     
     
    accessSecret : STRING
    The access secret to use when connecting to AWS.
     
     
    accesskey : STRING
    The access key to use when connecting to AWS.
     
     
    tags : SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.

    aws.ec2.EbsVolume

    Type Hierarchy udm.BaseProvisioned >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployedContainer, udm.Provisioned, udm.Deployed, udm.ConfigurationItem

    AWS EBS volume.

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Children
     
     
    provisioners : LIST_OF_CI<udm.AppliedProvisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    availabilityZone : STRING
    The Availability Zone in which to create the volume.
     
     
    ordinal : INTEGER  = 0
    The index of the cardinality amount created provisioneds.
     
     
    region : STRING
    AWS region to use. Cannot be modified once bucket is created in AWS.
     
     
    size : INTEGER
    The size of the volume, in GiBs. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size
     
     
    volumeType : ENUM [gp2, io1, st1, sc1, standard]  = standard
    The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes
     
     
    boundConfigurationItems : SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    encryption : BOOLEAN  = false
    Specifies whether the volume should be encrypted.
     
     
    iops : INTEGER
    Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume
     
     
    kmsKeyId : STRING
    The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume.
     
     
    snapshotId : STRING
    The snapshot from which to create the volume.
     
     
    volumeId : STRING
    Volume Id
     
     
    volumeName : STRING
    AWS EBS volume name.

    aws.ec2.EbsVolumeSpec

    Type Hierarchy udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Provisionable, udm.ConfigurationItem, udm.Taggable, udm.Deployable

    Specification for an AWS EBS volume.

    Children
     
     
    provisioners : LIST_OF_CI<udm.Provisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    availabilityZone : STRING
    The Availability Zone in which to create the volume. (string)
     
     
    boundTemplates : SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    cardinality : STRING  = 1
    Number of instances to launch.
     
     
    encryption : STRING  = false
    Specifies whether the volume should be encrypted. (boolean) default(false)
     
     
    iops : STRING
    Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume (integer)
     
     
    kmsKeyId : STRING
    The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. (string)
     
     
    region : STRING
    AWS region to use. Cannot be modified once bucket is created in AWS. (string)
     
     
    size : STRING
    The size of the volume, in GiBs. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size (integer)
     
     
    snapshotId : STRING
    The snapshot from which to create the volume. (string)
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    volumeId : STRING
    Volume Id (string)
     
     
    volumeName : STRING
    AWS EBS volume name. (string)
     
     
    volumeType : STRING  = standard
    The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes (enum) values(gp2, io1, st1, sc1, standard) default(standard)

    aws.ec2.Instance

    Type Hierarchy udm.BaseProvisioned >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployedContainer, udm.Provisioned, udm.Deployed, udm.ConfigurationItem

    AWS EC2 instance.

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Children
     
     
    provisioners : LIST_OF_CI<udm.AppliedProvisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    instanceBootRetryCount : INTEGER  = 5
    Number of times to check if instance is fully booted.
     
     
    instanceType : STRING  = m1.small
    The instance type that you specify determines the hardware of the host computer used for the instance.
     
     
    keyName : STRING  = default
    The name of the key pair, if the instance was launched with an associated key pair.
     
     
    ordinal : INTEGER  = 0
    The index of the cardinality amount created provisioneds.
     
     
    region : STRING
    AWS region to use.
     
     
    securityGroup : LIST_OF_STRING
    AWS security group to use.
     
     
    tenancy : ENUM [default, dedicated, host]  = default
    The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
     
     
    amiId : STRING
    Name/ID of the AMI to use. The name should be in the format Name:. If an ID is not provided, the name of the CI will be used.
     
     
    attachElasticIp : BOOLEAN
    Auto-assign Elastic IP
     
     
    availabilityZone : STRING
    The Availability Zone in which to create the instance.
     
     
    boundConfigurationItems : SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    detailedMonitoring : BOOLEAN  = false
    Indicates whether CloudWatch detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
     
     
    iAmRoleARN : STRING
    The Amazon Resource Name (ARN) of the IAM instance profile.
     
     
    instanceId : STRING
    ID of the AWS instance.
     
     
    instanceName : STRING
    Name of instance.
     
     
    instanceTags : MAP_STRING_STRING
    Adds one or more tags for the specified Amazon EC2 instance.
     
     
    networkInterfaces : MAP_STRING_STRING
    Key as the device index of the network interface and value as network interface name or Id. The name should be in the format Name:.
     
     
    publicHostname : STRING
    Public host name of the instance.
     
     
    publicIp : STRING
    Public IP address of the instance.
     
     
    shutdownBehavior : ENUM [stop, terminate]  = stop
    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
     
     
    subnet : STRING
    The ID or name of the subnet to launch the instance into. If not specified instance will be launched in a default subnet from the default VPC. Subnet must be specified if there is no default VPC. The name should be in the format Name:.
     
     
    terminationProtection : BOOLEAN  = false
    If this parameter is set to true, the instance cannot be terminated using the Amazon EC2 console, CLI, or API.
     
     
    userData : STRING
    The user data to make available to the instance.
     
     
    volumes : MAP_STRING_STRING
    Attach zero or more volumes to specified Amazon EC2 instance. The key should carry the name/ID of the volume, and the value should be the mount point. The name should be in the format Name:.

    aws.ec2.InstanceSpec

    Type Hierarchy udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Provisionable, udm.ConfigurationItem, udm.Taggable, udm.Deployable

    Specification for an AWS EC2 instance.

    Children
     
     
    provisioners : LIST_OF_CI<udm.Provisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    amiId : STRING
    Name/ID of the AMI to use. The name should be in the format Name:. If an ID is not provided, the name of the CI will be used. (string)
     
     
    attachElasticIp : STRING
    Auto-assign Elastic IP (boolean)
     
     
    availabilityZone : STRING
    The Availability Zone in which to create the instance. (string)
     
     
    boundTemplates : SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    cardinality : STRING  = 1
    Number of instances to launch.
     
     
    detailedMonitoring : STRING  = false
    Indicates whether CloudWatch detailed monitoring is enabled. Otherwise, basic monitoring is enabled. (boolean) default(false)
     
     
    iAmRoleARN : STRING
    The Amazon Resource Name (ARN) of the IAM instance profile. (string)
     
     
    instanceBootRetryCount : STRING  = 5
    Number of times to check if instance is fully booted. (integer) default(5)
     
     
    instanceId : STRING
    ID of the AWS instance. (string)
     
     
    instanceName : STRING
    Name of instance. (string)
     
     
    instanceTags : MAP_STRING_STRING
    Adds one or more tags for the specified Amazon EC2 instance. (map_string_string)
     
     
    instanceType : STRING  = m1.small
    The instance type that you specify determines the hardware of the host computer used for the instance. (string) default(m1.small)
     
     
    keyName : STRING  = default
    The name of the key pair, if the instance was launched with an associated key pair. (string) default(default)
     
     
    networkInterfaces : MAP_STRING_STRING
    Key as the device index of the network interface and value as network interface name or Id. The name should be in the format Name:. (map_string_string)
     
     
    publicHostname : STRING
    Public host name of the instance. (string)
     
     
    publicIp : STRING
    Public IP address of the instance. (string)
     
     
    region : STRING
    AWS region to use. (string)
     
     
    securityGroup : LIST_OF_STRING
    AWS security group to use. (list_of_string)
     
     
    shutdownBehavior : STRING  = stop
    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). (enum) values(stop, terminate) default(stop)
     
     
    subnet : STRING
    The ID or name of the subnet to launch the instance into. If not specified instance will be launched in a default subnet from the default VPC. Subnet must be specified if there is no default VPC. The name should be in the format Name:. (string)
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    tenancy : STRING  = default
    The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. (enum) values(default, dedicated, host) default(default)
     
     
    terminationProtection : STRING  = false
    If this parameter is set to true, the instance cannot be terminated using the Amazon EC2 console, CLI, or API. (boolean) default(false)
     
     
    userData : STRING
    The user data to make available to the instance. (string)
     
     
    volumes : MAP_STRING_STRING
    Attach zero or more volumes to specified Amazon EC2 instance. The key should carry the name/ID of the volume, and the value should be the mount point. The name should be in the format Name:. (map_string_string)

    aws.ec2.NetworkInterface

    Type Hierarchy udm.BaseProvisioned >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployedContainer, udm.Provisioned, udm.Deployed, udm.ConfigurationItem

    Creates a network interface.

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Children
     
     
    provisioners : LIST_OF_CI<udm.AppliedProvisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    ordinal : INTEGER  = 0
    The index of the cardinality amount created provisioneds.
     
     
    region : STRING
    AWS region to use.
     
     
    subnet : STRING
    The ID or name of the subnet associated with the network string. The name should be in the format Name:.
     
     
    boundConfigurationItems : SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    networkInterfaceDescription : STRING
    The description of the network interface.
     
     
    networkInterfaceId : STRING
    The ID of the network interface
     
     
    networkInterfaceName : STRING
    AWS network interface name.
     
     
    primaryIpAddress : STRING
    Primary private IPv4 addresses to assign to the network interface.
     
     
    secondaryIpAddress : STRING
    Secondary private IPv4 addresses to assign to the network interface.
     
     
    securityGroups : LIST_OF_STRING
    The id or name of one or more security groups.

    aws.ec2.NetworkInterfaceSpec

    Type Hierarchy udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Provisionable, udm.ConfigurationItem, udm.Taggable, udm.Deployable

    Creates a network interface.

    Children
     
     
    provisioners : LIST_OF_CI<udm.Provisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    boundTemplates : SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    cardinality : STRING  = 1
    Number of instances to launch.
     
     
    networkInterfaceDescription : STRING
    The description of the network interface. (string)
     
     
    networkInterfaceId : STRING
    The ID of the network interface (string)
     
     
    networkInterfaceName : STRING
    AWS network interface name. (string)
     
     
    primaryIpAddress : STRING
    Primary private IPv4 addresses to assign to the network interface. (string)
     
     
    region : STRING
    AWS region to use. (string)
     
     
    secondaryIpAddress : STRING
    Secondary private IPv4 addresses to assign to the network interface. (string)
     
     
    securityGroups : LIST_OF_STRING
    The id or name of one or more security groups. (list_of_string)
     
     
    subnet : STRING
    The ID or name of the subnet associated with the network string. The name should be in the format Name:. (string)
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.

    aws.s3.Archive

    Type Hierarchy file.Archive >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.ArchiveArtifact, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact

    Specification for an AWS S3 Archive.

    Public Properties
     
     
    acl : STRING
    The canned ACL to apply to the object. (enum) values(public-read, private, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control) default(private)
     
     
    checksum : STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    createTargetPath : STRING
    Create the targetPath on the host if it does not exist.
     
     
    excludeFileNamesRegex : STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileUri : STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    placeholders : SET_OF_STRING
    Placeholders detected in this artifact
     
     
    scanPlaceholders : BOOLEAN  = false
    Whether to scan this artifact for placeholders when it is imported
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    targetFileName : STRING
    Name of the file on bucket along with extension. (string)
     
     
    targetPath : STRING
    Path to which artifact must be copied to when being deployed.
     
     
    targetPathShared : STRING
    Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
    Hidden Properties
     
     
    textFileNamesRegex : STRING  = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
    Regular expression that matches file names of text files
     
     
    delimiters : STRING  = {{ }}
    The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
     
     
    fileEncodings : MAP_STRING_STRING  = {.+\.properties=ISO-8859-1}
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

    aws.s3.Bucket

    Type Hierarchy udm.BaseProvisionedContainer >> udm.BaseProvisioned >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployedContainer, udm.Provisioned, udm.Deployed, udm.Container, udm.ConfigurationItem, udm.Taggable

    AWS S3 bucket.

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Children
     
     
    provisioners : LIST_OF_CI<udm.AppliedProvisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    bucketName : STRING
    AWS S3 bucket name. Please check AWS bucket name restrictions on http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules. Cannot be modified once bucket is created in AWS.
     
     
    ordinal : INTEGER  = 0
    The index of the cardinality amount created provisioneds.
     
     
    region : STRING
    AWS region to use. Cannot be modified once bucket is created in AWS.
     
     
    boundConfigurationItems : SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    endpoint : STRING
    The region specific website endpoint of the bucket.
     
     
    errorDocument : STRING
    The object key name to use when a 4XX class error occurs. Required if staticWebsiteHosting is enabled.
     
     
    indexDocument : STRING
    A suffix that is appended to a request that is for a directory on the website endpoint. Required if staticWebsiteHosting is enabled.
     
     
    logging : BOOLEAN  = false
    Enable logging for your bucket to get detailed access logs delivered to the bucket of your choice.
     
     
    staticWebsiteHosting : BOOLEAN  = false
    Enable static website hosting for this S3 bucket.
     
     
    targetBucket : STRING
    Target bucket to save bucket logs. Required if logging is enabled.
     
     
    targetPrefix : STRING  = logs/
    To specify a key prefix for log objects. Required if logging is enabled.

    aws.s3.BucketSpec

    Type Hierarchy udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Provisionable, udm.ConfigurationItem, udm.Taggable, udm.Deployable

    Specification for an AWS S3 bucket.

    Children
     
     
    provisioners : LIST_OF_CI<udm.Provisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    boundTemplates : SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    bucketName : STRING
    AWS S3 bucket name. Please check AWS bucket name restrictions on http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules. Cannot be modified once bucket is created in AWS. (string)
     
     
    cardinality : STRING  = 1
    Number of instances to launch.
     
     
    endpoint : STRING
    The region specific website endpoint of the bucket. (string)
     
     
    errorDocument : STRING
    The object key name to use when a 4XX class error occurs. Required if staticWebsiteHosting is enabled. (string)
     
     
    indexDocument : STRING
    A suffix that is appended to a request that is for a directory on the website endpoint. Required if staticWebsiteHosting is enabled. (string)
     
     
    logging : STRING  = false
    Enable logging for your bucket to get detailed access logs delivered to the bucket of your choice. (boolean) default(false)
     
     
    region : STRING
    AWS region to use. Cannot be modified once bucket is created in AWS. (string)
     
     
    staticWebsiteHosting : STRING  = false
    Enable static website hosting for this S3 bucket. (boolean) default(false)
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    targetBucket : STRING
    Target bucket to save bucket logs. Required if logging is enabled. (string)
     
     
    targetPrefix : STRING  = logs/
    To specify a key prefix for log objects. Required if logging is enabled. (string) default(logs/)

    aws.s3.File

    Type Hierarchy file.File >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact

    Specification for an AWS S3 File.

    Public Properties
     
     
    acl : STRING
    The canned ACL to apply to the object. (enum) values(public-read, private, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control) default(private)
     
     
    checksum : STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    createTargetPath : STRING
    Create the targetPath on the host if it does not exist.
     
     
    excludeFileNamesRegex : STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileUri : STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    placeholders : SET_OF_STRING
    Placeholders detected in this artifact
     
     
    scanPlaceholders : BOOLEAN  = true
    Whether to scan this artifact for placeholders when it is imported
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    targetFileName : STRING
    Name of the file on bucket along with extension. (string)
     
     
    targetPath : STRING
    Path to which artifact must be copied to when being deployed.
     
     
    targetPathShared : STRING
    Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
    Hidden Properties
     
     
    textFileNamesRegex : STRING  = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
    Regular expression that matches file names of text files
     
     
    delimiters : STRING  = {{ }}
    The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
     
     
    fileEncodings : MAP_STRING_STRING  = {.+\.properties=ISO-8859-1}
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

    aws.s3.Folder

    Type Hierarchy file.Folder >> udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.FolderArtifact, udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable

    Specification for an AWS S3 Folder.

    Public Properties
     
     
    acl : STRING
    The canned ACL to apply to the object. (enum) values(public-read, private, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control) default(private)
     
     
    checksum : STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    createTargetPath : STRING
    Create the targetPath on the host if it does not exist.
     
     
    excludeFileNamesRegex : STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileUri : STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    placeholders : SET_OF_STRING
    Placeholders detected in this artifact
     
     
    scanPlaceholders : BOOLEAN  = true
    Whether to scan this artifact for placeholders when it is imported
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    targetPath : STRING
    Path to which artifact must be copied to when being deployed.
     
     
    targetPathShared : STRING
    Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
    Hidden Properties
     
     
    textFileNamesRegex : STRING  = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
    Regular expression that matches file names of text files
     
     
    delimiters : STRING  = {{ }}
    The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
     
     
    fileEncodings : MAP_STRING_STRING  = {.+\.properties=ISO-8859-1}
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

    aws.s3.UploadedArchive

    Type Hierarchy udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    AWS S3 File

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Public Properties
     
     
    acl : ENUM [public-read, private, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control]  = private
    The canned ACL to apply to the object.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders : MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
     
     
    targetFileName : STRING
    Name of the file on bucket along with extension.

    aws.s3.UploadedFile

    Type Hierarchy udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    AWS S3 File

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Public Properties
     
     
    acl : ENUM [public-read, private, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control]  = private
    The canned ACL to apply to the object.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders : MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
     
     
    targetFileName : STRING
    Name of the file on bucket along with extension.

    aws.s3.UploadedFolder

    Type Hierarchy udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    AWS S3 File

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Public Properties
     
     
    acl : ENUM [public-read, private, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control]  = private
    The canned ACL to apply to the object.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders : MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
    Copyright 2018. XebiaLabs, Inc. All rights reserved