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 AWS IoT UpdateDomainConfiguration API operation.

Syntax

Update-IOTDomainConfiguration
-DomainConfigurationName <String>
-AuthorizerConfig_AllowAuthorizerOverride <Boolean>
-ApplicationProtocol <ApplicationProtocol>
-AuthenticationType <AuthenticationType>
-ClientCertificateConfig_ClientCertificateCallbackArn <String>
-AuthorizerConfig_DefaultAuthorizerName <String>
-DomainConfigurationStatus <DomainConfigurationStatus>
-ServerCertificateConfig_EnableOCSPCheck <Boolean>
-ServerCertificateConfig_OcspAuthorizedResponderArn <String>
-ServerCertificateConfig_OcspLambdaArn <String>
-RemoveAuthorizerConfig <Boolean>
-TlsConfig_SecurityPolicy <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonIoTConfig>

Description

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action.

Parameters

-ApplicationProtocol <ApplicationProtocol>
An enumerated string that specifies the application-layer protocol.
  • SECURE_MQTT - MQTT over TLS.
  • MQTT_WSS - MQTT over WebSocket.
  • HTTPS - HTTP over TLS.
  • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuthenticationType <AuthenticationType>
An enumerated string that specifies the authentication type.
  • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.
  • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.
  • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuthorizerConfig_AllowAuthorizerOverride <Boolean>
A Boolean that specifies whether the domain configuration's authorization service can be overridden.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuthorizerConfig_DefaultAuthorizerName <String>
The name of the authorization service for a domain configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientCertificateConfig_ClientCertificateCallbackArn <String>
The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonIoTConfig>
Amazon.PowerShell.Cmdlets.IOT.AmazonIoTClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainConfigurationName <String>
The name of the domain configuration to be updated.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DomainConfigurationStatus <DomainConfigurationStatus>
The status to which the domain configuration should be updated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DomainConfigurationName parameter. The -PassThru parameter is deprecated, use -Select '^DomainConfigurationName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RemoveAuthorizerConfig <Boolean>
Removes the authorization configuration from a domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.IoT.Model.UpdateDomainConfigurationResponse). Specifying the name of a property of type Amazon.IoT.Model.UpdateDomainConfigurationResponse 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)
-ServerCertificateConfig_EnableOCSPCheck <Boolean>
A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server certificate check is enabled or not.For more information, see Server certificate configuration for OCSP stapling from Amazon Web Services IoT Core Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerCertificateConfig_OcspAuthorizedResponderArn <String>
The Amazon Resource Name (ARN) for an X.509 certificate stored in Amazon Web Services Certificate Manager (ACM). If provided, Amazon Web Services IoT Core will use this certificate to validate the signature of the received OCSP response. The OCSP responder must sign responses using either this authorized responder certificate or the issuing certificate, depending on whether the ARN is provided or not. The certificate must be in the same Amazon Web Services account and region as the domain configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerCertificateConfig_OcspLambdaArn <String>
The Amazon Resource Name (ARN) for a Lambda function that acts as a Request for Comments (RFC) 6960-compliant Online Certificate Status Protocol (OCSP) responder, supporting basic OCSP responses. The Lambda function accepts a base64-encoding of the OCSP request in the Distinguished Encoding Rules (DER) format. The Lambda function's response is also a base64-encoded OCSP response in the DER format. The response size must not exceed 4 kilobytes (KiB). The Lambda function must be in the same Amazon Web Services account and region as the domain configuration. For more information, see Configuring server certificate OCSP for private endpoints in Amazon Web Services IoT Core from the Amazon Web Services IoT Core developer guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TlsConfig_SecurityPolicy <String>
The security policy for a domain configuration. For more information, see Security policies in the Amazon Web Services IoT Core developer guide.
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

Amazon.IoT.Model.UpdateDomainConfigurationResponse
This cmdlet returns an Amazon.IoT.Model.UpdateDomainConfigurationResponse object containing multiple properties.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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