Class: Aws::AlexaForBusiness::Types::CreateNetworkProfileRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::CreateNetworkProfileRequest
- Defined in:
- gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb
Overview
When making an API call, you may pass CreateNetworkProfileRequest data as a hash:
{
network_profile_name: "NetworkProfileName", # required
description: "NetworkProfileDescription",
ssid: "NetworkSsid", # required
security_type: "OPEN", # required, accepts OPEN, WEP, WPA_PSK, WPA2_PSK, WPA2_ENTERPRISE
eap_method: "EAP_TLS", # accepts EAP_TLS
current_password: "CurrentWiFiPassword",
next_password: "NextWiFiPassword",
certificate_authority_arn: "Arn",
trust_anchors: ["TrustAnchor"],
client_request_token: "ClientRequestToken", # required
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Constant Summary collapse
- SENSITIVE =
[:current_password, :next_password]
Instance Attribute Summary collapse
-
#certificate_authority_arn ⇒ String
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM).
-
#client_request_token ⇒ String
A unique, user-specified identifier for the request that ensures idempotency.
-
#current_password ⇒ String
The current password of the Wi-Fi network.
-
#description ⇒ String
Detailed information about a device's network profile.
-
#eap_method ⇒ String
The authentication standard that is used in the EAP framework.
-
#network_profile_name ⇒ String
The name of the network profile associated with a device.
-
#next_password ⇒ String
The next, or subsequent, password of the Wi-Fi network.
-
#security_type ⇒ String
The security type of the Wi-Fi network.
-
#ssid ⇒ String
The SSID of the Wi-Fi network.
-
#tags ⇒ Array<Types::Tag>
The tags to be added to the specified resource.
-
#trust_anchors ⇒ Array<String>
The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.
Instance Attribute Details
#certificate_authority_arn ⇒ String
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#client_request_token ⇒ String
A unique, user-specified identifier for the request that ensures idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#current_password ⇒ String
The current password of the Wi-Fi network.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#description ⇒ String
Detailed information about a device's network profile.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#eap_method ⇒ String
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#network_profile_name ⇒ String
The name of the network profile associated with a device.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#next_password ⇒ String
The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#security_type ⇒ String
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#ssid ⇒ String
The SSID of the Wi-Fi network.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
The tags to be added to the specified resource. Do not provide system tags.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |
#trust_anchors ⇒ Array<String>
The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1301 class CreateNetworkProfileRequest < Struct.new( :network_profile_name, :description, :ssid, :security_type, :eap_method, :current_password, :next_password, :certificate_authority_arn, :trust_anchors, :client_request_token, :tags) SENSITIVE = [:current_password, :next_password] include Aws::Structure end |