Package com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.model

Class ConfigurationMetadata

    • Method Detail

      • getConfigType

        public String getConfigType()
        Gets the configType. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template, custom_credentials_configuration.
        Returns:
        the configType

      • getName

        public String getName()
        Gets the name. The unique name of your configuration.
        Returns:
        the name

      • getSecretType

        public String getSecretType()
        Gets the secretType. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
        Returns:
        the secretType

      • getCreatedBy

        public String getCreatedBy()
        Gets the createdBy. The unique identifier that is associated with the entity that created the secret.
        Returns:
        the createdBy

      • getCreatedAt

        public Date getCreatedAt()
        Gets the createdAt. The date when the resource was created. The date format follows `RFC 3339`.
        Returns:
        the createdAt

      • getUpdatedAt

        public Date getUpdatedAt()
        Gets the updatedAt. The date when a resource was modified. The date format follows `RFC 3339`.
        Returns:
        the updatedAt

      • isDisabled

        public Boolean isDisabled()
        Gets the disabled. This parameter indicates whether the API key configuration is disabled.
        Returns:
        the disabled

      • getLetsEncryptEnvironment

        public String getLetsEncryptEnvironment()
        Gets the letsEncryptEnvironment. The configuration of the Let's Encrypt CA environment.
        Returns:
        the letsEncryptEnvironment

      • getLetsEncryptPreferredChain

        public String getLetsEncryptPreferredChain()
        Gets the letsEncryptPreferredChain. This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
        Returns:
        the letsEncryptPreferredChain

      • getCommonName

        public String getCommonName()
        Gets the commonName. The Common Name (CN) represents the server name that is protected by the SSL certificate.
        Returns:
        the commonName

      • isCrlDistributionPointsEncoded

        public Boolean isCrlDistributionPointsEncoded()
        Gets the crlDistributionPointsEncoded. This field determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are issued by this certificate authority.
        Returns:
        the crlDistributionPointsEncoded

      • getExpirationDate

        public Date getExpirationDate()
        Gets the expirationDate. The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types: arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, username_password, and custom_credentials.
        Returns:
        the expirationDate

      • getKeyType

        public String getKeyType()
        Gets the keyType. The type of private key to generate.
        Returns:
        the keyType

      • getKeyBits

        public Long getKeyBits()
        Gets the keyBits. The number of bits to use to generate the private key. Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.
        Returns:
        the keyBits

      • getStatus

        public String getStatus()
        Gets the status. The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`, `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
        Returns:
        the status

      • getCryptoKey

        public PrivateCertificateCryptoKey getCryptoKey()
        Gets the cryptoKey. The data that is associated with a cryptographic key.
        Returns:
        the cryptoKey

      • getIssuer

        public String getIssuer()
        Gets the issuer. The distinguished name that identifies the entity that signed and issued the certificate.
        Returns:
        the issuer

      • getSigningMethod

        public String getSigningMethod()
        Gets the signingMethod. The signing method to use with this certificate authority to generate private certificates. You can choose between internal or externally signed options. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).
        Returns:
        the signingMethod

      • getCertificateAuthority

        public String getCertificateAuthority()
        Gets the certificateAuthority. The name of the intermediate certificate authority.
        Returns:
        the certificateAuthority

      • getCodeEngineKeyRef

        public String getCodeEngineKeyRef()
        Gets the codeEngineKeyRef. The IAM API key used by the credentials provider to access this Secrets Manager instance.
        Returns:
        the codeEngineKeyRef

      • getApiKeyRef

        public String getApiKeyRef()
        Gets the apiKeyRef. The IAM credentials secret ID that is used for setting up a custom credentials engine configuration.
        Returns:
        the apiKeyRef

      • getSchema

        public CustomCredentialsConfigurationSchema getSchema()
        Gets the schema. The schema that defines by the Code Engine job to be used as input and output formats for this custom credentials configuration.
        Returns:
        the schema

      • getTaskTimeout

        public String getTaskTimeout()
        Gets the taskTimeout. Specifies the maximum allowed time for a Code Engine task to be completed. After this time elapses, the task state will changed to failed. The minimum value is 5 minutes and the maximum value is 24 hours. Default task time out is 10 minutes. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `10m` or `2h`.
        Returns:
        the taskTimeout