Amazon.PowerShell.Cmdlets.EC2IB.AmazonImagebuilderClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The idempotency token used to make this request idempotent.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
Aliases | InstanceMetadataOptions_HttpTokens |
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
Aliases | InstanceTypes |
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) |
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) |
The tags attached to the resource created by Image Builder.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ResourceTags |
The S3 bucket in which to store the logs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Logging_S3Logs_S3BucketName |
The Amazon S3 path to the bucket where the logs are stored.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Logging_S3Logs_S3KeyPrefix |
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) |
Aliases | SecurityGroupIds |
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) |
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) |
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) |