/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the imagebuilder-2019-12-02.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.Imagebuilder.Model
{
///
/// An Image Builder image. You must specify exactly one recipe for the image – either
/// a container recipe (containerRecipe
), which creates a container image,
/// or an image recipe (imageRecipe
), which creates an AMI.
///
public partial class Image
{
private string _arn;
private BuildType _buildType;
private ContainerRecipe _containerRecipe;
private string _dateCreated;
private DistributionConfiguration _distributionConfiguration;
private bool? _enhancedImageMetadataEnabled;
private ImageRecipe _imageRecipe;
private ImageScanningConfiguration _imageScanningConfiguration;
private ImageSource _imageSource;
private ImageTestsConfiguration _imageTestsConfiguration;
private InfrastructureConfiguration _infrastructureConfiguration;
private string _name;
private string _osVersion;
private OutputResources _outputResources;
private Platform _platform;
private ImageScanState _scanState;
private string _sourcePipelineArn;
private string _sourcePipelineName;
private ImageState _state;
private Dictionary _tags = new Dictionary();
private ImageType _type;
private string _version;
///
/// Gets and sets the property Arn.
///
/// The Amazon Resource Name (ARN) of the image.
///
///
///
/// Semantic versioning is included in each object's Amazon Resource Name (ARN), at the
/// level that applies to that object as follows:
///
/// -
///
/// Versionless ARNs and Name ARNs do not include specific values in any of the nodes.
/// The nodes are either left off entirely, or they are specified as wildcards, for example:
/// x.x.x.
///
///
-
///
/// Version ARNs have only the first three nodes: <major>.<minor>.<patch>
///
///
-
///
/// Build version ARNs have all four nodes, and point to a specific build for a specific
/// version of an object.
///
///
///
public string Arn
{
get { return this._arn; }
set { this._arn = value; }
}
// Check to see if Arn property is set
internal bool IsSetArn()
{
return this._arn != null;
}
///
/// Gets and sets the property BuildType.
///
/// Indicates the type of build that created this image. The build can be initiated in
/// the following ways:
///
/// -
///
/// USER_INITIATED – A manual pipeline build request.
///
///
-
///
/// SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder
/// pipeline, or from EventBridge.
///
///
-
///
/// IMPORT – A VM import created the image to use as the base image for the recipe.
///
///
///
public BuildType BuildType
{
get { return this._buildType; }
set { this._buildType = value; }
}
// Check to see if BuildType property is set
internal bool IsSetBuildType()
{
return this._buildType != null;
}
///
/// Gets and sets the property ContainerRecipe.
///
/// For container images, this is the container recipe that Image Builder used to create
/// the image. For images that distribute an AMI, this is empty.
///
///
public ContainerRecipe ContainerRecipe
{
get { return this._containerRecipe; }
set { this._containerRecipe = value; }
}
// Check to see if ContainerRecipe property is set
internal bool IsSetContainerRecipe()
{
return this._containerRecipe != null;
}
///
/// Gets and sets the property DateCreated.
///
/// The date on which Image Builder created this image.
///
///
public string DateCreated
{
get { return this._dateCreated; }
set { this._dateCreated = value; }
}
// Check to see if DateCreated property is set
internal bool IsSetDateCreated()
{
return this._dateCreated != null;
}
///
/// Gets and sets the property DistributionConfiguration.
///
/// The distribution configuration that Image Builder used to create this image.
///
///
public DistributionConfiguration DistributionConfiguration
{
get { return this._distributionConfiguration; }
set { this._distributionConfiguration = value; }
}
// Check to see if DistributionConfiguration property is set
internal bool IsSetDistributionConfiguration()
{
return this._distributionConfiguration != null;
}
///
/// Gets and sets the property EnhancedImageMetadataEnabled.
///
/// Indicates whether Image Builder collects additional information about the image, such
/// as the operating system (OS) version and package list.
///
///
public bool EnhancedImageMetadataEnabled
{
get { return this._enhancedImageMetadataEnabled.GetValueOrDefault(); }
set { this._enhancedImageMetadataEnabled = value; }
}
// Check to see if EnhancedImageMetadataEnabled property is set
internal bool IsSetEnhancedImageMetadataEnabled()
{
return this._enhancedImageMetadataEnabled.HasValue;
}
///
/// Gets and sets the property ImageRecipe.
///
/// For images that distribute an AMI, this is the image recipe that Image Builder used
/// to create the image. For container images, this is empty.
///
///
public ImageRecipe ImageRecipe
{
get { return this._imageRecipe; }
set { this._imageRecipe = value; }
}
// Check to see if ImageRecipe property is set
internal bool IsSetImageRecipe()
{
return this._imageRecipe != null;
}
///
/// Gets and sets the property ImageScanningConfiguration.
///
/// Contains settings for vulnerability scans.
///
///
public ImageScanningConfiguration ImageScanningConfiguration
{
get { return this._imageScanningConfiguration; }
set { this._imageScanningConfiguration = value; }
}
// Check to see if ImageScanningConfiguration property is set
internal bool IsSetImageScanningConfiguration()
{
return this._imageScanningConfiguration != null;
}
///
/// Gets and sets the property ImageSource.
///
/// The origin of the base image that Image Builder used to build this image.
///
///
public ImageSource ImageSource
{
get { return this._imageSource; }
set { this._imageSource = value; }
}
// Check to see if ImageSource property is set
internal bool IsSetImageSource()
{
return this._imageSource != null;
}
///
/// Gets and sets the property ImageTestsConfiguration.
///
/// The image tests that ran when that Image Builder created this image.
///
///
public ImageTestsConfiguration ImageTestsConfiguration
{
get { return this._imageTestsConfiguration; }
set { this._imageTestsConfiguration = value; }
}
// Check to see if ImageTestsConfiguration property is set
internal bool IsSetImageTestsConfiguration()
{
return this._imageTestsConfiguration != null;
}
///
/// Gets and sets the property InfrastructureConfiguration.
///
/// The infrastructure that Image Builder used to create this image.
///
///
public InfrastructureConfiguration InfrastructureConfiguration
{
get { return this._infrastructureConfiguration; }
set { this._infrastructureConfiguration = value; }
}
// Check to see if InfrastructureConfiguration property is set
internal bool IsSetInfrastructureConfiguration()
{
return this._infrastructureConfiguration != null;
}
///
/// Gets and sets the property Name.
///
/// The name of the image.
///
///
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
///
/// Gets and sets the property OsVersion.
///
/// The operating system version for instances that launch from this image. For example,
/// Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
///
///
[AWSProperty(Min=1)]
public string OsVersion
{
get { return this._osVersion; }
set { this._osVersion = value; }
}
// Check to see if OsVersion property is set
internal bool IsSetOsVersion()
{
return this._osVersion != null;
}
///
/// Gets and sets the property OutputResources.
///
/// The output resources that Image Builder produces for this image.
///
///
public OutputResources OutputResources
{
get { return this._outputResources; }
set { this._outputResources = value; }
}
// Check to see if OutputResources property is set
internal bool IsSetOutputResources()
{
return this._outputResources != null;
}
///
/// Gets and sets the property Platform.
///
/// The image operating system platform, such as Linux or Windows.
///
///
public Platform Platform
{
get { return this._platform; }
set { this._platform = value; }
}
// Check to see if Platform property is set
internal bool IsSetPlatform()
{
return this._platform != null;
}
///
/// Gets and sets the property ScanState.
///
/// Contains information about the current state of scans for this image.
///
///
public ImageScanState ScanState
{
get { return this._scanState; }
set { this._scanState = value; }
}
// Check to see if ScanState property is set
internal bool IsSetScanState()
{
return this._scanState != null;
}
///
/// Gets and sets the property SourcePipelineArn.
///
/// The Amazon Resource Name (ARN) of the image pipeline that created this image.
///
///
public string SourcePipelineArn
{
get { return this._sourcePipelineArn; }
set { this._sourcePipelineArn = value; }
}
// Check to see if SourcePipelineArn property is set
internal bool IsSetSourcePipelineArn()
{
return this._sourcePipelineArn != null;
}
///
/// Gets and sets the property SourcePipelineName.
///
/// The name of the image pipeline that created this image.
///
///
public string SourcePipelineName
{
get { return this._sourcePipelineName; }
set { this._sourcePipelineName = value; }
}
// Check to see if SourcePipelineName property is set
internal bool IsSetSourcePipelineName()
{
return this._sourcePipelineName != null;
}
///
/// Gets and sets the property State.
///
/// The state of the image.
///
///
public ImageState State
{
get { return this._state; }
set { this._state = value; }
}
// Check to see if State property is set
internal bool IsSetState()
{
return this._state != null;
}
///
/// Gets and sets the property Tags.
///
/// The tags that apply to this image.
///
///
[AWSProperty(Min=1, Max=50)]
public Dictionary Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
///
/// Gets and sets the property Type.
///
/// Specifies whether this image produces an AMI or a container image.
///
///
public ImageType Type
{
get { return this._type; }
set { this._type = value; }
}
// Check to see if Type property is set
internal bool IsSetType()
{
return this._type != null;
}
///
/// Gets and sets the property Version.
///
/// The semantic version of the image.
///
///
///
/// The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
/// You can assign values for the first three, and can filter on all of them.
///
///
///
/// Assignment: For the first three nodes you can assign any positive integer
/// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node.
/// Image Builder automatically assigns the build number to the fourth node.
///
///
///
/// Patterns: You can use any numeric pattern that adheres to the assignment requirements
/// for the nodes that you can assign. For example, you might choose a software version
/// pattern, such as 1.0.0, or a date, such as 2021.01.01.
///
///
///
/// Filtering: With semantic versioning, you have the flexibility to use wildcards
/// (x) to specify the most recent versions or nodes when selecting the base image or
/// components for your recipe. When you use a wildcard in any node, all nodes to the
/// right of the first wildcard must also be wildcards.
///
///
///
public string Version
{
get { return this._version; }
set { this._version = value; }
}
// Check to see if Version property is set
internal bool IsSetVersion()
{
return this._version != null;
}
}
}