You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AlexaForBusiness::Types::CreateNetworkProfileRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

Note:

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
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_authority_arnString

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

Returns:

  • (String)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end

#client_request_tokenString

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.

Returns:

  • (String)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end

#current_passwordString

The current password of the Wi-Fi network.

Returns:

  • (String)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end

#descriptionString

Detailed information about a device's network profile.

Returns:

  • (String)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end

#eap_methodString

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

Returns:

  • (String)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end

#network_profile_nameString

The name of the network profile associated with a device.

Returns:

  • (String)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end

#next_passwordString

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.

Returns:

  • (String)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end

#security_typeString

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

Returns:

  • (String)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end

#ssidString

The SSID of the Wi-Fi network.

Returns:

  • (String)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end

#trust_anchorsArray<String>

The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

Returns:

  • (Array<String>)


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1073

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)
  include Aws::Structure
end