create_domain_configuration
¶
create_domain_configuration(
domain_configuration_name: DomainConfigurationName,
*,
config_overrides: Optional[IoTClientConfig] = None,
domain_name: Optional[DomainName] = None,
server_certificate_arns: Optional[ServerCertificateArns] = None,
validation_certificate_arn: Optional[AcmCertificateArn] = None,
authorizer_config: Optional[AuthorizerConfig] = None,
service_type: Optional[ServiceType] = None,
tags: Optional[TagList] = None,
tls_config: Optional[TlsConfig] = None,
server_certificate_config: Optional[ServerCertificateConfig] = None,
authentication_type: Optional[AuthenticationType] = None,
application_protocol: Optional[ApplicationProtocol] = None,
client_certificate_config: Optional[ClientCertificateConfig] = None,
) -> CreateDomainConfigurationResponse
Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
Parameters:
-
domain_configuration_name(DomainConfigurationName) –The name of the domain configuration. This value must be unique to a region.
-
domain_name(Optional[DomainName], default:None) –The name of the domain.
-
server_certificate_arns(Optional[ServerCertificateArns], default:None) –The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.
-
validation_certificate_arn(Optional[AcmCertificateArn], default:None) –The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.
-
authorizer_config(Optional[AuthorizerConfig], default:None) –An object that specifies the authorization service for a domain.
-
service_type(Optional[ServiceType], default:None) –The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the
DATAservice type. -
tags(Optional[TagList], default:None) –Metadata which can be used to manage the domain configuration.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
-
tls_config(Optional[TlsConfig], default:None) –An object that specifies the TLS configuration for a domain.
-
server_certificate_config(Optional[ServerCertificateConfig], default:None) –The server certificate configuration.
-
authentication_type(Optional[AuthenticationType], default:None) –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.
-
CUSTOM_AUTH- Use custom authentication and authorization. For more information, see Custom authentication and authorization.
-
AWS_X509- Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.
-
AWS_SIGV4- Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.
-
DEFAULT- Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.
-
-
application_protocol(Optional[ApplicationProtocol], default:None) –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.
-
-
client_certificate_config(Optional[ClientCertificateConfig], default:None) –An object that specifies the client certificate configuration for a domain.
Raises:
-
CertificateValidationException–The certificate is invalid.
-
InternalFailureException–An unexpected error has occurred.
-
InvalidRequestException–The request is not valid.
-
LimitExceededException–A limit has been exceeded.
-
ResourceAlreadyExistsException–The resource already exists.
-
ServiceUnavailableException–The service is temporarily unavailable.
-
ThrottlingException–The rate exceeds the limit.
-
UnauthorizedException–You are not authorized to perform this operation.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_iot/_services/io_t.py
2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 | |