Class CreateNetworkProfileRequest

    • Method Detail

      • networkProfileName

        public final String networkProfileName()

        The name of the network profile associated with a device.

        Returns:
        The name of the network profile associated with a device.
      • description

        public final String description()

        Detailed information about a device's network profile.

        Returns:
        Detailed information about a device's network profile.
      • ssid

        public final String ssid()

        The SSID of the Wi-Fi network.

        Returns:
        The SSID of the Wi-Fi network.
      • securityTypeAsString

        public final String securityTypeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, securityType will return NetworkSecurityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityTypeAsString().

        Returns:
        The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
        See Also:
        NetworkSecurityType
      • eapMethod

        public final NetworkEapMethod eapMethod()

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

        If the service returns an enum value that is not available in the current SDK version, eapMethod will return NetworkEapMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eapMethodAsString().

        Returns:
        The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
        See Also:
        NetworkEapMethod
      • eapMethodAsString

        public final String eapMethodAsString()

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

        If the service returns an enum value that is not available in the current SDK version, eapMethod will return NetworkEapMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eapMethodAsString().

        Returns:
        The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
        See Also:
        NetworkEapMethod
      • currentPassword

        public final String currentPassword()

        The current password of the Wi-Fi network.

        Returns:
        The current password of the Wi-Fi network.
      • nextPassword

        public final String nextPassword()

        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:
        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.
      • certificateAuthorityArn

        public final String certificateAuthorityArn()

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

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

        public final boolean hasTrustAnchors()
        For responses, this returns true if the service returned a value for the TrustAnchors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • trustAnchors

        public final List<String> trustAnchors()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTrustAnchors() method.

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

        public final String clientRequestToken()
        Returns the value of the ClientRequestToken property for this object.
        Returns:
        The value of the ClientRequestToken property for this object.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final List<Tag> tags()

        The tags to be added to the specified resource. Do not provide system tags.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tags to be added to the specified resource. Do not provide system tags.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object