AWS.Tools.Imagebuilder.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Imagebuilder</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.AddEC2IBResourceTagCmdlet"> <summary> Adds a tag to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.AddEC2IBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.AddEC2IBResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to apply to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.AddEC2IBResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.AddEC2IBResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentCmdlet"> <summary> Gets a component object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentCmdlet.ComponentBuildVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix <c>/\d+$</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Component'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetComponentResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetComponentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentBuildVersionListCmdlet"> <summary> Returns the list of component build versions for the specified semantic version. <note><para> 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. </para><para><b>Filtering:</b> 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. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentBuildVersionListCmdlet.ComponentVersionArn"> <summary> <para> <para>The component version Amazon Resource Name (ARN) whose versions you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentBuildVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentBuildVersionListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentBuildVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComponentSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListComponentBuildVersionsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListComponentBuildVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentBuildVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentListCmdlet"> <summary> Returns the list of components that can be filtered by name, or by using the listed <c>filters</c> to streamline results. Newly created components can take up to two minutes to appear in the ListComponents API Results. <note><para> 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. </para><para><b>Filtering:</b> 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. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentListCmdlet.ByName"> <summary> <para> <para>Returns the list of components for the specified name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentListCmdlet.Filter"> <summary> <para> <para>Use the following filters to streamline results:</para><ul><li><para><c>description</c></para></li><li><para><c>name</c></para></li><li><para><c>platform</c></para></li><li><para><c>supportedOsVersion</c></para></li><li><para><c>type</c></para></li><li><para><c>version</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentListCmdlet.Owner"> <summary> <para> <para>Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, third party components, or components that other accounts have shared with you.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComponentVersionList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListComponentsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListComponentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentPolicyCmdlet"> <summary> Gets a component policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentPolicyCmdlet.ComponentArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBComponentPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetComponentPolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetComponentPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeCmdlet"> <summary> Retrieves a container recipe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeCmdlet.ContainerRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the container recipe to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContainerRecipe'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetContainerRecipeResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetContainerRecipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeListCmdlet"> <summary> Returns a list of container recipes.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeListCmdlet.Filter"> <summary> <para> <para>Use the following filters to streamline results:</para><ul><li><para><c>containerType</c></para></li><li><para><c>name</c></para></li><li><para><c>parentImage</c></para></li><li><para><c>platform</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeListCmdlet.Owner"> <summary> <para> <para>Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContainerRecipeSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListContainerRecipesResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListContainerRecipesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipePolicyCmdlet"> <summary> Retrieves the policy for a container recipe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipePolicyCmdlet.ContainerRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the container recipe for the policy being requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBContainerRecipePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetContainerRecipePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetContainerRecipePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBDistributionConfigurationCmdlet"> <summary> Gets a distribution configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBDistributionConfigurationCmdlet.DistributionConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBDistributionConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetDistributionConfigurationResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetDistributionConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBDistributionConfigurationListCmdlet"> <summary> Returns a list of distribution configurations.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBDistributionConfigurationListCmdlet.Filter"> <summary> <para> <para>You can filter on <c>name</c> to streamline results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBDistributionConfigurationListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBDistributionConfigurationListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBDistributionConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionConfigurationSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListDistributionConfigurationsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListDistributionConfigurationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBDistributionConfigurationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageCmdlet"> <summary> Gets an image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageCmdlet.ImageBuildVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image that you want to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Image'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetImageResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageBuildVersionListCmdlet"> <summary> Returns a list of image build versions.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageBuildVersionListCmdlet.Filter"> <summary> <para> <para>Use the following filters to streamline results:</para><ul><li><para><c>name</c></para></li><li><para><c>osVersion</c></para></li><li><para><c>platform</c></para></li><li><para><c>type</c></para></li><li><para><c>version</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageBuildVersionListCmdlet.ImageVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageBuildVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageBuildVersionListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageBuildVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListImageBuildVersionsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListImageBuildVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageBuildVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageListCmdlet"> <summary> Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageListCmdlet.ByName"> <summary> <para> <para>Requests a list of images with a specific recipe name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageListCmdlet.Filter"> <summary> <para> <para>Use the following filters to streamline results:</para><ul><li><para><c>name</c></para></li><li><para><c>osVersion</c></para></li><li><para><c>platform</c></para></li><li><para><c>type</c></para></li><li><para><c>version</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageListCmdlet.IncludeDeprecated"> <summary> <para> <para>Includes deprecated images in the response list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageListCmdlet.Owner"> <summary> <para> <para>The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageVersionList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListImagesResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListImagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePackageListCmdlet"> <summary> List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePackageListCmdlet.ImageBuildVersionArn"> <summary> <para> <para>Filter results for the ListImagePackages request by the Image Build Version ARN</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePackageListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePackageListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePackageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImagePackageList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListImagePackagesResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListImagePackagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePackageListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineCmdlet"> <summary> Gets an image pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineCmdlet.ImagePipelineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImagePipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetImagePipelineResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetImagePipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineImageListCmdlet"> <summary> Returns a list of images created by the specified pipeline.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineImageListCmdlet.Filter"> <summary> <para> <para>Use the following filters to streamline results:</para><ul><li><para><c>name</c></para></li><li><para><c>version</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineImageListCmdlet.ImagePipelineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineImageListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineImageListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineImageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListImagePipelineImagesResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListImagePipelineImagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineImageListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineListCmdlet"> <summary> Returns a list of image pipelines.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineListCmdlet.Filter"> <summary> <para> <para>Use the following filters to streamline results:</para><ul><li><para><c>description</c></para></li><li><para><c>distributionConfigurationArn</c></para></li><li><para><c>imageRecipeArn</c></para></li><li><para><c>infrastructureConfigurationArn</c></para></li><li><para><c>name</c></para></li><li><para><c>status</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImagePipelineList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListImagePipelinesResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListImagePipelinesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePipelineListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePolicyCmdlet"> <summary> Gets an image policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePolicyCmdlet.ImageArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImagePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetImagePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetImagePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeCmdlet"> <summary> Gets an image recipe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeCmdlet.ImageRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageRecipe'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetImageRecipeResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetImageRecipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeListCmdlet"> <summary> Returns a list of image recipes.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeListCmdlet.Filter"> <summary> <para> <para>Use the following filters to streamline results:</para><ul><li><para><c>name</c></para></li><li><para><c>parentImage</c></para></li><li><para><c>platform</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeListCmdlet.Owner"> <summary> <para> <para>The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageRecipeSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListImageRecipesResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListImageRecipesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipePolicyCmdlet"> <summary> Gets an image recipe policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipePolicyCmdlet.ImageRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageRecipePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetImageRecipePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetImageRecipePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingAggregationListCmdlet"> <summary> Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the <c>imagePipelineArn</c> filter. If you don't specify a filter, Image Builder returns an aggregation for your account. <para> To streamline results, you can use the following filters in your request: </para><ul><li><para><c>accountId</c></para></li><li><para><c>imageBuildVersionArn</c></para></li><li><para><c>imagePipelineArn</c></para></li><li><para><c>vulnerabilityId</c></para></li></ul><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingAggregationListCmdlet.Filter_Name"> <summary> <para> <para>The name of the filter. Filter names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingAggregationListCmdlet.Filter_Value"> <summary> <para> <para>The filter values. Filter values are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingAggregationListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingAggregationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListImageScanFindingAggregationsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListImageScanFindingAggregationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingAggregationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingListCmdlet"> <summary> Returns a list of image scan findings for your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingListCmdlet.Filter"> <summary> <para> <para>An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:</para><ul><li><para><c>imageBuildVersionArn</c></para></li><li><para><c>imagePipelineArn</c></para></li><li><para><c>vulnerabilityId</c></para></li><li><para><c>severity</c></para></li></ul><para>If you don't request a filter, then all findings in your account are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Findings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListImageScanFindingsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListImageScanFindingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBImageScanFindingListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBInfrastructureConfigurationCmdlet"> <summary> Gets an infrastructure configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBInfrastructureConfigurationCmdlet.InfrastructureConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBInfrastructureConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InfrastructureConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetInfrastructureConfigurationResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetInfrastructureConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBInfrastructureConfigurationListCmdlet"> <summary> Returns a list of infrastructure configurations.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBInfrastructureConfigurationListCmdlet.Filter"> <summary> <para> <para>You can filter on <c>name</c> to streamline results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBInfrastructureConfigurationListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBInfrastructureConfigurationListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBInfrastructureConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InfrastructureConfigurationSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListInfrastructureConfigurationsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListInfrastructureConfigurationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBInfrastructureConfigurationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionCmdlet"> <summary> Get the runtime information that was logged for a specific runtime instance of the lifecycle policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionCmdlet.LifecycleExecutionId"> <summary> <para> <para>Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecycleExecution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetLifecycleExecutionResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetLifecycleExecutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionListCmdlet"> <summary> Get the lifecycle runtime history for the specified resource.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionListCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which to get a list of lifecycle runtime instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecycleExecutions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListLifecycleExecutionsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListLifecycleExecutionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionResourceListCmdlet"> <summary> List resources that the runtime instance of the image lifecycle identified for lifecycle actions.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionResourceListCmdlet.LifecycleExecutionId"> <summary> <para> <para>Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionResourceListCmdlet.ParentResourceId"> <summary> <para> <para>You can leave this empty to get a list of Image Builder resources that were identified for lifecycle actions.</para><para>To get a list of associated resources that are impacted for an individual resource (the parent), specify its Amazon Resource Name (ARN). Associated resources are produced from your image and distributed when you run a build, such as AMIs or container images stored in ECR repositories.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionResourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionResourceListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListLifecycleExecutionResourcesResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListLifecycleExecutionResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecycleExecutionResourceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecyclePolicyCmdlet"> <summary> Get details for the specified image lifecycle policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecyclePolicyCmdlet.LifecyclePolicyArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecyclePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecyclePolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetLifecyclePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetLifecyclePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecyclePolicyListCmdlet"> <summary> Get a list of lifecycle policies in your Amazon Web Services account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecyclePolicyListCmdlet.Filter"> <summary> <para> <para>Streamline results based on one of the following values: <c>Name</c>, <c>Status</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecyclePolicyListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecyclePolicyListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecyclePolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecyclePolicySummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListLifecyclePoliciesResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListLifecyclePoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBLifecyclePolicyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBResourceTagCmdlet"> <summary> Returns the list of tags for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWaitingWorkflowStepListCmdlet"> <summary> Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWaitingWorkflowStepListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWaitingWorkflowStepListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWaitingWorkflowStepListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Steps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListWaitingWorkflowStepsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListWaitingWorkflowStepsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWaitingWorkflowStepListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowCmdlet"> <summary> Get a workflow resource object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowCmdlet.WorkflowBuildVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the workflow resource that you want to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workflow'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetWorkflowResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetWorkflowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowBuildVersionListCmdlet"> <summary> Returns a list of build versions for a specific workflow resource.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowBuildVersionListCmdlet.WorkflowVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowBuildVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowBuildVersionListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowBuildVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkflowSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListWorkflowBuildVersionsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListWorkflowBuildVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowBuildVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowExecutionCmdlet"> <summary> Get the runtime information that was logged for a specific runtime instance of the workflow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowExecutionCmdlet.WorkflowExecutionId"> <summary> <para> <para>Use the unique identifier for a runtime instance of the workflow to get runtime details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetWorkflowExecutionResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetWorkflowExecutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowExecutionListCmdlet"> <summary> Returns a list of workflow runtime instance metadata objects for a specific image build version.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowExecutionListCmdlet.ImageBuildVersionArn"> <summary> <para> <para>List all workflow runtime instances for the specified image build version resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowExecutionListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListWorkflowExecutionsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListWorkflowExecutionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowExecutionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowListCmdlet"> <summary> Lists workflow build versions based on filtering parameters.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowListCmdlet.ByName"> <summary> <para> <para>Specify all or part of the workflow name to streamline results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowListCmdlet.Filter"> <summary> <para> <para>Used to streamline search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowListCmdlet.Owner"> <summary> <para> <para>Used to get a list of workflow build version filtered by the identity of the creator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkflowVersionList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListWorkflowsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListWorkflowsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowStepExecutionCmdlet"> <summary> Get the runtime information that was logged for a specific runtime instance of the workflow step. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowStepExecutionCmdlet.StepExecutionId"> <summary> <para> <para>Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowStepExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.GetWorkflowStepExecutionResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.GetWorkflowStepExecutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowStepExecutionListCmdlet"> <summary> Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowStepExecutionListCmdlet.WorkflowExecutionId"> <summary> <para> <para>The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowStepExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum items to return in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowStepExecutionListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowStepExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListWorkflowStepExecutionsResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ListWorkflowStepExecutionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.GetEC2IBWorkflowStepExecutionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet"> <summary> Imports a component and transforms its data into a component document. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.ChangeDescription"> <summary> <para> <para>The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Data"> <summary> <para> <para>The data of the component. Used to specify the data inline. Either <c>data</c> or <c>uri</c> can be used to specify the data within the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Description"> <summary> <para> <para>The description of the component. Describes the contents of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Format"> <summary> <para> <para>The format of the resource that you want to import as a component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.KmsKeyId"> <summary> <para> <para>The ID of the KMS key that should be used to encrypt this component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Name"> <summary> <para> <para>The name of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Platform"> <summary> <para> <para>The platform of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the component. This version follows the semantic version syntax.</para><note><para>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.</para><para><b>Filtering:</b> 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.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Tag"> <summary> <para> <para>The tags of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Type"> <summary> <para> <para>The type of the component denotes whether the component is used to build the image, or only to test it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Uri"> <summary> <para> <para>The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either <c>data</c> or <c>uri</c> can be used to specify the data within the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComponentBuildVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ImportComponentResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ImportComponentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBComponentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet"> <summary> When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html">ImportImage</a> action uses those files to import your VM and create an AMI. To import using the CLI command, see <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html">import-image</a><para> You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.Description"> <summary> <para> <para>The description for the base image that is created by the import process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.Name"> <summary> <para> <para>The name of the base image that is created by the import process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.OsVersion"> <summary> <para> <para>The operating system version for the imported VM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.Platform"> <summary> <para> <para>The operating system platform for the imported VM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.</para><note><para>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.</para><para><b>Assignment:</b> 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.</para><para><b>Patterns:</b> 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.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.Tag"> <summary> <para> <para>Tags that are attached to the import resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.VmImportTaskId"> <summary> <para> <para>The <c>importTaskId</c> (API) or <c>ImportTaskId</c> (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ImportVmImageResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.ImportVmImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.ImportEC2IBVmImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet"> <summary> Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods: <ul><li><para> Inline, using the <c>data</c> property in the request body. </para></li><li><para> A URL that points to a YAML document file stored in Amazon S3, using the <c>uri</c> property in the request body. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.ChangeDescription"> <summary> <para> <para>The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.Data"> <summary> <para> <para>Component <c>data</c> contains inline YAML document content for the component. Alternatively, you can specify the <c>uri</c> of a YAML document file stored in Amazon S3. However, you cannot specify both properties.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.Description"> <summary> <para> <para>Describes the contents of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.KmsKeyId"> <summary> <para> <para>The ID of the KMS key that is used to encrypt this component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.Name"> <summary> <para> <para>The name of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.Platform"> <summary> <para> <para>The operating system platform of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the component. This version follows the semantic version syntax.</para><note><para>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.</para><para><b>Assignment:</b> 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.</para><para><b>Patterns:</b> 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.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.SupportedOsVersion"> <summary> <para> <para>The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.Tag"> <summary> <para> <para>The tags that apply to the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.Uri"> <summary> <para> <para>The <c>uri</c> of a YAML component document file. This must be an S3 URL (<c>s3://bucket/key</c>), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.</para><para>Alternatively, you can specify the YAML document inline, using the component <c>data</c> property. You cannot specify both properties.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComponentBuildVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateComponentResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateComponentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBComponentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet"> <summary> Creates a new container recipe. Container recipes define how images are configured, tested, and assessed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.InstanceConfiguration_BlockDeviceMapping"> <summary> <para> <para>Defines the block devices to attach for building an instance from this Image Builder AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.Component"> <summary> <para> <para>Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.ContainerType"> <summary> <para> <para>The type of container to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.Description"> <summary> <para> <para>The description of the container recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.DockerfileTemplateData"> <summary> <para> <para>The Dockerfile template used to build your image as an inline data blob.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.DockerfileTemplateUri"> <summary> <para> <para>The Amazon S3 URI for the Dockerfile that will be used to build your container image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.InstanceConfiguration_Image"> <summary> <para> <para>The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.ImageOsVersionOverride"> <summary> <para> <para>Specifies the operating system version for the base image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.KmsKeyId"> <summary> <para> <para>Identifies which KMS key is used to encrypt the container image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.Name"> <summary> <para> <para>The name of the container recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.ParentImage"> <summary> <para> <para>The base image for the container recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.PlatformOverride"> <summary> <para> <para>Specifies the operating system platform when you use a custom base image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.TargetRepository_RepositoryName"> <summary> <para> <para>The name of the container repository where the output container image is stored. This name is prefixed by the repository location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the container recipe. This version follows the semantic version syntax.</para><note><para>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.</para><para><b>Assignment:</b> 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.</para><para><b>Patterns:</b> 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.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.TargetRepository_Service"> <summary> <para> <para>Specifies the service in which this image was registered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.Tag"> <summary> <para> <para>Tags that are attached to the container recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.WorkingDirectory"> <summary> <para> <para>The working directory for use during build and test workflows.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContainerRecipeArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateContainerRecipeResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateContainerRecipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBContainerRecipeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBDistributionConfigurationCmdlet"> <summary> Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBDistributionConfigurationCmdlet.Description"> <summary> <para> <para>The description of the distribution configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBDistributionConfigurationCmdlet.Distribution"> <summary> <para> <para>The distributions of the distribution configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBDistributionConfigurationCmdlet.Name"> <summary> <para> <para>The name of the distribution configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBDistributionConfigurationCmdlet.Tag"> <summary> <para> <para>The tags of the distribution configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBDistributionConfigurationCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBDistributionConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionConfigurationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateDistributionConfigurationResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateDistributionConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBDistributionConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet"> <summary> Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.ContainerRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.EcrConfiguration_ContainerTag"> <summary> <para> <para>Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.DistributionConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.EnhancedImageMetadataEnabled"> <summary> <para> <para>Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.ExecutionRole"> <summary> <para> <para>The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.ImageRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.ImageScanningConfiguration_ImageScanningEnabled"> <summary> <para> <para>A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.ImageTestsConfiguration_ImageTestsEnabled"> <summary> <para> <para>Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.InfrastructureConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.EcrConfiguration_RepositoryName"> <summary> <para> <para>The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named <c>image-builder-image-scanning-repository</c> for vulnerability scans of your output container images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.Tag"> <summary> <para> <para>The tags of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.ImageTestsConfiguration_TimeoutMinute"> <summary> <para> <para>The maximum time in minutes that tests are permitted to run.</para><note><para>The timeoutMinutes attribute is not currently active. This value is ignored.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.Workflow"> <summary> <para> <para>Contains an array of workflow configuration objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuildVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateImageResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet"> <summary> Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.ContainerRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.EcrConfiguration_ContainerTag"> <summary> <para> <para>Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Description"> <summary> <para> <para>The description of the image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.DistributionConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.EnhancedImageMetadataEnabled"> <summary> <para> <para>Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.ExecutionRole"> <summary> <para> <para>The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.ImageRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.ImageScanningConfiguration_ImageScanningEnabled"> <summary> <para> <para>A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.ImageTestsConfiguration_ImageTestsEnabled"> <summary> <para> <para>Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.InfrastructureConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Name"> <summary> <para> <para>The name of the image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Schedule_PipelineExecutionStartCondition"> <summary> <para> <para>The condition configures when the pipeline should trigger a new image build. When the <c>pipelineExecutionStartCondition</c> is set to <c>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</c>, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to <c>EXPRESSION_MATCH_ONLY</c>, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html">CreateComponent</a> in the <i> EC2 Image Builder API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.EcrConfiguration_RepositoryName"> <summary> <para> <para>The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named <c>image-builder-image-scanning-repository</c> for vulnerability scans of your output container images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Schedule_ScheduleExpression"> <summary> <para> <para>The cron expression determines how often EC2 Image Builder evaluates your <c>pipelineExecutionStartCondition</c>.</para><para>For information on how to format a cron expression in Image Builder, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html">Use cron expressions in EC2 Image Builder</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Status"> <summary> <para> <para>The status of the image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Tag"> <summary> <para> <para>The tags of the image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.ImageTestsConfiguration_TimeoutMinute"> <summary> <para> <para>The maximum time in minutes that tests are permitted to run.</para><note><para>The timeoutMinutes attribute is not currently active. This value is ignored.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Schedule_Timezone"> <summary> <para> <para>The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the <a href="https://www.joda.org/joda-time/timezones.html">IANA timezone format</a>. If not specified this defaults to UTC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Workflow"> <summary> <para> <para>Contains an array of workflow configuration objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImagePipelineArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateImagePipelineResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateImagePipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImagePipelineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet"> <summary> Creates a new image recipe. Image recipes define how images are configured, tested, and assessed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.BlockDeviceMapping"> <summary> <para> <para>The block device mappings of the image recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.Component"> <summary> <para> <para>The components included in the image recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.Description"> <summary> <para> <para>The description of the image recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.Name"> <summary> <para> <para>The name of the image recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.ParentImage"> <summary> <para> <para>The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: <c>arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x</c>. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the image recipe. This version follows the semantic version syntax.</para><note><para>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.</para><para><b>Assignment:</b> 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.</para><para><b>Patterns:</b> 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.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.Tag"> <summary> <para> <para>The tags of the image recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.SystemsManagerAgent_UninstallAfterBuild"> <summary> <para> <para>Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.AdditionalInstanceConfiguration_UserDataOverride"> <summary> <para> <para>Use this property to provide commands or a command script to run when you launch your build instance.</para><para>The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.</para><note><para>The user data is always base 64 encoded. For example, the following commands are encoded as <c>IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$</c>:</para><para><i>#!/bin/bash</i></para><para>mkdir -p /var/bb/</para><para>touch /var</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.WorkingDirectory"> <summary> <para> <para>The working directory used during build and test workflows.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageRecipeArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateImageRecipeResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateImageRecipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBImageRecipeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet"> <summary> Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.Description"> <summary> <para> <para>The description of the infrastructure configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.InstanceMetadataOptions_HttpPutResponseHopLimit"> <summary> <para> <para>Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.InstanceMetadataOptions_HttpToken"> <summary> <para> <para>Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:</para><ul><li><para><b>required</b> – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.</para></li><li><para><b>optional</b> – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.</para></li></ul><para>The default setting is <b>optional</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.InstanceProfileName"> <summary> <para> <para>The instance profile to associate with the instance used to customize your Amazon EC2 AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.InstanceType"> <summary> <para> <para>The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.KeyPair"> <summary> <para> <para>The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.Name"> <summary> <para> <para>The name of the infrastructure configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.ResourceTag"> <summary> <para> <para>The tags attached to the resource created by Image Builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.S3Logs_S3BucketName"> <summary> <para> <para>The S3 bucket in which to store the logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.S3Logs_S3KeyPrefix"> <summary> <para> <para>The Amazon S3 path to the bucket where the logs are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.SecurityGroupId"> <summary> <para> <para>The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.SnsTopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.</para><note><para>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.SubnetId"> <summary> <para> <para>The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.Tag"> <summary> <para> <para>The tags of the infrastructure configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.TerminateInstanceOnFailure"> <summary> <para> <para>The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InfrastructureConfigurationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateInfrastructureConfigurationResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateInfrastructureConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBInfrastructureConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet"> <summary> Create a lifecycle policy resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.Description"> <summary> <para> <para>Optional description for the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.ExecutionRole"> <summary> <para> <para>The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.Name"> <summary> <para> <para>The name of the lifecycle policy to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.PolicyDetail"> <summary> <para> <para>Configuration details for the lifecycle policy rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.ResourceSelection_Recipe"> <summary> <para> <para>A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.ResourceType"> <summary> <para> <para>The type of Image Builder resource that the lifecycle policy applies to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.Status"> <summary> <para> <para>Indicates whether the lifecycle policy resource is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.ResourceSelection_TagMap"> <summary> <para> <para>A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.Tag"> <summary> <para> <para>Tags to apply to the lifecycle policy resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecyclePolicyArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateLifecyclePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateLifecyclePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBLifecyclePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet"> <summary> Create a new workflow or a new version of an existing workflow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.ChangeDescription"> <summary> <para> <para>Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.Data"> <summary> <para> <para>Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the <c>uri</c> of a YAML document file stored in Amazon S3. However, you cannot specify both properties.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.Description"> <summary> <para> <para>Describes the workflow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.KmsKeyId"> <summary> <para> <para>The ID of the KMS key that is used to encrypt this workflow resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.Name"> <summary> <para> <para>The name of the workflow to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.</para><note><para>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.</para><para><b>Assignment:</b> 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.</para><para><b>Patterns:</b> 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.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.Tag"> <summary> <para> <para>Tags that apply to the workflow resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.Type"> <summary> <para> <para>The phase in the image build process for which the workflow resource is responsible.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.Uri"> <summary> <para> <para>The <c>uri</c> of a YAML component document file. This must be an S3 URL (<c>s3://bucket/key</c>), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.</para><para>Alternatively, you can specify the YAML document inline, using the component <c>data</c> property. You cannot specify both properties.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkflowBuildVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateWorkflowResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateWorkflowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.NewEC2IBWorkflowCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBComponentCmdlet"> <summary> Deletes a component build version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBComponentCmdlet.ComponentBuildVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the component build version to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.DeleteComponentResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.DeleteComponentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBComponentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBContainerRecipeCmdlet"> <summary> Deletes a container recipe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBContainerRecipeCmdlet.ContainerRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the container recipe to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBContainerRecipeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContainerRecipeArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.DeleteContainerRecipeResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.DeleteContainerRecipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBContainerRecipeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBDistributionConfigurationCmdlet"> <summary> Deletes a distribution configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBDistributionConfigurationCmdlet.DistributionConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the distribution configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBDistributionConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.DeleteDistributionConfigurationResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.DeleteDistributionConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBDistributionConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImageCmdlet"> <summary> Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands. <ul><li><para> To deregister an EC2 Linux AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html">Deregister your Linux AMI</a> in the <i><i>Amazon EC2 User Guide</i></i>. </para></li><li><para> To deregister an EC2 Windows AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/deregister-ami.html">Deregister your Windows AMI</a> in the <i><i>Amazon EC2 Windows Guide</i></i>. </para></li><li><para> To delete a container image from Amazon ECR, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html">Deleting an image</a> in the <i>Amazon ECR User Guide</i>. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImageCmdlet.ImageBuildVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Image Builder image resource to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.DeleteImageResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.DeleteImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImagePipelineCmdlet"> <summary> Deletes an image pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImagePipelineCmdlet.ImagePipelineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image pipeline to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImagePipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.DeleteImagePipelineResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.DeleteImagePipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImagePipelineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImageRecipeCmdlet"> <summary> Deletes an image recipe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImageRecipeCmdlet.ImageRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image recipe to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImageRecipeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.DeleteImageRecipeResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.DeleteImageRecipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBImageRecipeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBInfrastructureConfigurationCmdlet"> <summary> Deletes an infrastructure configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBInfrastructureConfigurationCmdlet.InfrastructureConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the infrastructure configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBInfrastructureConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.DeleteInfrastructureConfigurationResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.DeleteInfrastructureConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBInfrastructureConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBLifecyclePolicyCmdlet"> <summary> Delete the specified lifecycle policy resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBLifecyclePolicyCmdlet.LifecyclePolicyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the lifecycle policy resource to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBLifecyclePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecyclePolicyArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.DeleteLifecyclePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.DeleteLifecyclePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBLifecyclePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBResourceTagCmdlet"> <summary> Removes a tag from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to untag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBWorkflowCmdlet"> <summary> Deletes a specific workflow resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBWorkflowCmdlet.WorkflowBuildVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the workflow resource to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBWorkflowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkflowBuildVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.DeleteWorkflowResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.DeleteWorkflowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.RemoveEC2IBWorkflowCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.SendEC2IBWorkflowStepActionCmdlet"> <summary> Pauses or resumes image creation when the associated workflow runs a <c>WaitForAction</c> step. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.SendEC2IBWorkflowStepActionCmdlet.Action"> <summary> <para> <para>The action for the image creation process to take while a workflow <c>WaitForAction</c> step waits for an asynchronous action to complete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.SendEC2IBWorkflowStepActionCmdlet.ImageBuildVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image build version to send action for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.SendEC2IBWorkflowStepActionCmdlet.Reason"> <summary> <para> <para>The reason why this action is sent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.SendEC2IBWorkflowStepActionCmdlet.StepExecutionId"> <summary> <para> <para>Uniquely identifies the workflow step that sent the step action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.SendEC2IBWorkflowStepActionCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.SendEC2IBWorkflowStepActionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.SendWorkflowStepActionResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.SendWorkflowStepActionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.SendEC2IBWorkflowStepActionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBImagePipelineExecutionCmdlet"> <summary> Manually triggers a pipeline to create an image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBImagePipelineExecutionCmdlet.ImagePipelineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBImagePipelineExecutionCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBImagePipelineExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuildVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.StartImagePipelineExecutionResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.StartImagePipelineExecutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBImagePipelineExecutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet"> <summary> Begin asynchronous resource state update for lifecycle changes to the specified image resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.IncludeResources_Ami"> <summary> <para> <para>Specifies whether the lifecycle action should apply to distributed AMIs</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.IncludeResources_Container"> <summary> <para> <para>Specifies whether the lifecycle action should apply to distributed containers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.ExecutionRole"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.Amis_IsPublic"> <summary> <para> <para>Configures whether public AMIs are excluded from the lifecycle action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.Amis_Region"> <summary> <para> <para>Configures Amazon Web Services Regions that are excluded from the lifecycle action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the Image Builder resource that is updated. The state update might also impact associated resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.Amis_SharedAccount"> <summary> <para> <para>Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.IncludeResources_Snapshot"> <summary> <para> <para>Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.State_Status"> <summary> <para> <para>Shows the current lifecycle policy action that was applied to an impacted resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.Amis_TagMap"> <summary> <para> <para>Lists tags that should be excluded from lifecycle actions for the AMIs that have them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.LastLaunched_Unit"> <summary> <para> <para>Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.UpdateAt"> <summary> <para> <para>The timestamp that indicates when resources are updated by a lifecycle action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.LastLaunched_Value"> <summary> <para> <para>The integer number of units for the time period. For example <c>6</c> (months).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.StartResourceStateUpdateResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.StartResourceStateUpdateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StartEC2IBResourceStateUpdateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBImageCreationCmdlet"> <summary> CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBImageCreationCmdlet.ImageBuildVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image that you want to cancel creation for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBImageCreationCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBImageCreationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuildVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CancelImageCreationResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CancelImageCreationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBImageCreationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBLifecycleExecutionCmdlet"> <summary> Cancel a specific image lifecycle policy runtime instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBLifecycleExecutionCmdlet.LifecycleExecutionId"> <summary> <para> <para>Identifies the specific runtime instance of the image lifecycle to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBLifecycleExecutionCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBLifecycleExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecycleExecutionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CancelLifecycleExecutionResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CancelLifecycleExecutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.StopEC2IBLifecycleExecutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBDistributionConfigurationCmdlet"> <summary> Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBDistributionConfigurationCmdlet.Description"> <summary> <para> <para>The description of the distribution configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBDistributionConfigurationCmdlet.DistributionConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the distribution configuration that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBDistributionConfigurationCmdlet.Distribution"> <summary> <para> <para>The distributions of the distribution configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBDistributionConfigurationCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBDistributionConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionConfigurationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.UpdateDistributionConfigurationResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.UpdateDistributionConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBDistributionConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet"> <summary> Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a <c>containerRecipeArn</c> or an <c>imageRecipeArn</c>. <note><para> UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.ContainerRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the container pipeline to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.EcrConfiguration_ContainerTag"> <summary> <para> <para>Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.Description"> <summary> <para> <para>The description of the image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.DistributionConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.EnhancedImageMetadataEnabled"> <summary> <para> <para>Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.ExecutionRole"> <summary> <para> <para>The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.ImagePipelineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image pipeline that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.ImageRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.ImageScanningConfiguration_ImageScanningEnabled"> <summary> <para> <para>A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.ImageTestsConfiguration_ImageTestsEnabled"> <summary> <para> <para>Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.InfrastructureConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.Schedule_PipelineExecutionStartCondition"> <summary> <para> <para>The condition configures when the pipeline should trigger a new image build. When the <c>pipelineExecutionStartCondition</c> is set to <c>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</c>, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to <c>EXPRESSION_MATCH_ONLY</c>, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html">CreateComponent</a> in the <i> EC2 Image Builder API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.EcrConfiguration_RepositoryName"> <summary> <para> <para>The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named <c>image-builder-image-scanning-repository</c> for vulnerability scans of your output container images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.Schedule_ScheduleExpression"> <summary> <para> <para>The cron expression determines how often EC2 Image Builder evaluates your <c>pipelineExecutionStartCondition</c>.</para><para>For information on how to format a cron expression in Image Builder, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html">Use cron expressions in EC2 Image Builder</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.Status"> <summary> <para> <para>The status of the image pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.ImageTestsConfiguration_TimeoutMinute"> <summary> <para> <para>The maximum time in minutes that tests are permitted to run.</para><note><para>The timeoutMinutes attribute is not currently active. This value is ignored.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.Schedule_Timezone"> <summary> <para> <para>The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the <a href="https://www.joda.org/joda-time/timezones.html">IANA timezone format</a>. If not specified this defaults to UTC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.Workflow"> <summary> <para> <para>Contains the workflows to run for the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImagePipelineArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.UpdateImagePipelineResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.UpdateImagePipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBImagePipelineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet"> <summary> Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.Description"> <summary> <para> <para>The description of the infrastructure configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.InstanceMetadataOptions_HttpPutResponseHopLimit"> <summary> <para> <para>Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.InstanceMetadataOptions_HttpToken"> <summary> <para> <para>Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:</para><ul><li><para><b>required</b> – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.</para></li><li><para><b>optional</b> – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.</para></li></ul><para>The default setting is <b>optional</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.InfrastructureConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.InstanceProfileName"> <summary> <para> <para>The instance profile to associate with the instance used to customize your Amazon EC2 AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.InstanceType"> <summary> <para> <para>The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.KeyPair"> <summary> <para> <para>The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.ResourceTag"> <summary> <para> <para>The tags attached to the resource created by Image Builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.S3Logs_S3BucketName"> <summary> <para> <para>The S3 bucket in which to store the logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.S3Logs_S3KeyPrefix"> <summary> <para> <para>The Amazon S3 path to the bucket where the logs are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.SecurityGroupId"> <summary> <para> <para>The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.SnsTopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.</para><note><para>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.SubnetId"> <summary> <para> <para>The subnet ID to place the instance used to customize your Amazon EC2 AMI in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.TerminateInstanceOnFailure"> <summary> <para> <para>The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InfrastructureConfigurationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.UpdateInfrastructureConfigurationResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.UpdateInfrastructureConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBInfrastructureConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet"> <summary> Update the specified lifecycle policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.Description"> <summary> <para> <para>Optional description for the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.ExecutionRole"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.LifecyclePolicyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the lifecycle policy resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.PolicyDetail"> <summary> <para> <para>The configuration details for a lifecycle policy resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.ResourceSelection_Recipe"> <summary> <para> <para>A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.ResourceType"> <summary> <para> <para>The type of image resource that the lifecycle policy applies to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.Status"> <summary> <para> <para>Indicates whether the lifecycle policy resource is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.ResourceSelection_TagMap"> <summary> <para> <para>A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecyclePolicyArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.UpdateLifecyclePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.UpdateLifecyclePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.UpdateEC2IBLifecyclePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBComponentPolicyCmdlet"> <summary> Applies a policy to a component. We recommend that you call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html">CreateResourceShare</a> to share resources. If you call the Image Builder API <c>PutComponentPolicy</c>, you must also call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be visible to all principals with whom the resource is shared. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBComponentPolicyCmdlet.ComponentArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the component that this policy should be applied to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBComponentPolicyCmdlet.Policy"> <summary> <para> <para>The policy to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBComponentPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.PutComponentPolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.PutComponentPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBComponentPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBContainerRecipePolicyCmdlet"> <summary> Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API <c>PutContainerImagePolicy</c>, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBContainerRecipePolicyCmdlet.ContainerRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBContainerRecipePolicyCmdlet.Policy"> <summary> <para> <para>The policy to apply to the container recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBContainerRecipePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContainerRecipeArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.PutContainerRecipePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.PutContainerRecipePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBContainerRecipePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImagePolicyCmdlet"> <summary> Applies a policy to an image. We recommend that you call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html">CreateResourceShare</a> to share resources. If you call the Image Builder API <c>PutImagePolicy</c>, you must also call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be visible to all principals with whom the resource is shared. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImagePolicyCmdlet.ImageArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image that this policy should be applied to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImagePolicyCmdlet.Policy"> <summary> <para> <para>The policy to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImagePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.PutImagePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.PutImagePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImagePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImageRecipePolicyCmdlet"> <summary> Applies a policy to an image recipe. We recommend that you call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html">CreateResourceShare</a> to share resources. If you call the Image Builder API <c>PutImageRecipePolicy</c>, you must also call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be visible to all principals with whom the resource is shared. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImageRecipePolicyCmdlet.ImageRecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImageRecipePolicyCmdlet.Policy"> <summary> <para> <para>The policy to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImageRecipePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.PutImageRecipePolicyResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.PutImageRecipePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IB.WriteEC2IBImageRecipePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |