AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the EC2 Image Builder UpdateInfrastructureConfiguration API operation.

Syntax

Update-EC2IBInfrastructureConfiguration
-InfrastructureConfigurationArn <String>
-Description <String>
-InstanceMetadataOptions_HttpPutResponseHopLimit <Int32>
-InstanceMetadataOptions_HttpToken <String>
-InstanceProfileName <String>
-InstanceType <String[]>
-KeyPair <String>
-ResourceTag <Hashtable>
-S3Logs_S3BucketName <String>
-S3Logs_S3KeyPrefix <String>
-SecurityGroupId <String[]>
-SnsTopicArn <String>
-SubnetId <String>
-TerminateInstanceOnFailure <Boolean>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonImagebuilderConfig>

Description

Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

Parameters

-ClientConfig <AmazonImagebuilderConfig>
Amazon.PowerShell.Cmdlets.EC2IB.AmazonImagebuilderClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
The idempotency token used to make this request idempotent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description of the infrastructure configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InfrastructureConfigurationArn <String>
The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-InstanceMetadataOptions_HttpPutResponseHopLimit <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceMetadataOptions_HttpToken <String>
Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:
  • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
  • optional – 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.
The default setting is optional.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceMetadataOptions_HttpTokens
-InstanceProfileName <String>
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceType <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceTypes
-KeyPair <String>
The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the InfrastructureConfigurationArn parameter. The -PassThru parameter is deprecated, use -Select '^InfrastructureConfigurationArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceTag <Hashtable>
The tags attached to the resource created by Image Builder.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceTags
-S3Logs_S3BucketName <String>
The S3 bucket in which to store the logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogging_S3Logs_S3BucketName
-S3Logs_S3KeyPrefix <String>
The Amazon S3 path to the bucket where the logs are stored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogging_S3Logs_S3KeyPrefix
-SecurityGroupId <String[]>
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupIds
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnsTopicArn <String>
The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SubnetId <String>
The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TerminateInstanceOnFailure <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a System.String object. The service call response (type Amazon.Imagebuilder.Model.UpdateInfrastructureConfigurationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z