Package software.amazon.awssdk.services.iot.model

Interface RegisterCaCertificateRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RegisterCaCertificateRequest.Builder,RegisterCaCertificateRequest>, IotRequest.Builder, SdkBuilder<RegisterCaCertificateRequest.Builder,RegisterCaCertificateRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RegisterCaCertificateRequest
public static interface RegisterCaCertificateRequest.Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder<RegisterCaCertificateRequest.Builder,RegisterCaCertificateRequest>

  • Method Details

    • caCertificate

      RegisterCaCertificateRequest.Builder caCertificate(String caCertificate)

      The CA certificate.

      Parameters:
      caCertificate - The CA certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • verificationCertificate

      RegisterCaCertificateRequest.Builder verificationCertificate(String verificationCertificate)

      The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

      Parameters:
      verificationCertificate - The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setAsActive

      RegisterCaCertificateRequest.Builder setAsActive(Boolean setAsActive)

      A boolean value that specifies if the CA certificate is set to active.

      Valid values: ACTIVE | INACTIVE

      Parameters:
      setAsActive - A boolean value that specifies if the CA certificate is set to active.

      Valid values: ACTIVE | INACTIVE

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowAutoRegistration

      RegisterCaCertificateRequest.Builder allowAutoRegistration(Boolean allowAutoRegistration)

      Allows this CA certificate to be used for auto registration of device certificates.

      Parameters:
      allowAutoRegistration - Allows this CA certificate to be used for auto registration of device certificates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registrationConfig

      RegisterCaCertificateRequest.Builder registrationConfig(RegistrationConfig registrationConfig)

      Information about the registration configuration.

      Parameters:
      registrationConfig - Information about the registration configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registrationConfig

      default RegisterCaCertificateRequest.Builder registrationConfig(Consumer<RegistrationConfig.Builder> registrationConfig)

      Information about the registration configuration.

      This is a convenience method that creates an instance of the RegistrationConfig.Builder avoiding the need to create one manually via RegistrationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to registrationConfig(RegistrationConfig).

      Parameters:
      registrationConfig - a consumer that will call methods on RegistrationConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      RegisterCaCertificateRequest.Builder tags(Collection<Tag> tags)

      Metadata which can be used to manage the CA certificate.

      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..."

      Parameters:
      tags - Metadata which can be used to manage the CA certificate.

      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..."

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RegisterCaCertificateRequest.Builder tags(Tag... tags)

      Metadata which can be used to manage the CA certificate.

      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..."

      Parameters:
      tags - Metadata which can be used to manage the CA certificate.

      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..."

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RegisterCaCertificateRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Metadata which can be used to manage the CA certificate.

      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..."

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • certificateMode

      RegisterCaCertificateRequest.Builder certificateMode(String certificateMode)

      Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

      Parameters:
      certificateMode - Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • certificateMode

      RegisterCaCertificateRequest.Builder certificateMode(CertificateMode certificateMode)

      Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

      Parameters:
      certificateMode - Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      RegisterCaCertificateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RegisterCaCertificateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.