com.aliyun.ros.cdk.cloudsso.SAMLIdentityProviderProps Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ros-cdk-cloudsso Show documentation
There is a newer version: 1.4.0
package com.aliyun.ros.cdk.cloudsso;

/**
 * Properties for defining a SAMLIdentityProvider.
 * 
 * See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cloudsso-samlidentityprovider
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-04-09T06:05:31.037Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.cloudsso.$Module.class, fqn = "@alicloud/ros-cdk-cloudsso.SAMLIdentityProviderProps")
@software.amazon.jsii.Jsii.Proxy(SAMLIdentityProviderProps.Jsii$Proxy.class)
public interface SAMLIdentityProviderProps extends software.amazon.jsii.JsiiSerializable {

    /**
     * Property directoryId: The ID of the directory.
     */
    @org.jetbrains.annotations.NotNull java.lang.Object getDirectoryId();

    /**
     * Property encodedMetadataDocument: The metadata file of the IdP.
     * 

     * The value of this parameter is Base64-encoded.
     * The file is provided by the IdP that supports SAML 2.0.
     */
    default @org.jetbrains.annotations.Nullable java.lang.Object getEncodedMetadataDocument() {
        return null;
    }

    /**
     * Property entityId: The entity ID of the IdP.
     */
    default @org.jetbrains.annotations.Nullable java.lang.Object getEntityId() {
        return null;
    }

    /**
     * Property loginUrl: The logon URL of the IdP.
     */
    default @org.jetbrains.annotations.Nullable java.lang.Object getLoginUrl() {
        return null;
    }

    /**
     * Property ssoStatus: The status of SSO logon.
     * 

     * Valid values:
     * 

     * 

     * Enabled
     * Disabled (default)
     * 
     */
    default @org.jetbrains.annotations.Nullable java.lang.Object getSsoStatus() {
        return null;
    }

    /**
     * Property wantRequestSigned: Specifies whether CloudSSO needs to sign SAML requests.
     * 
     * The requests are sent when users log on to the CloudSSO user portal to initiate SAML-based SSO. Valid values:
     * 

     * 

     * true: yes
     * false: no (default)
     * 
     */
    default @org.jetbrains.annotations.Nullable java.lang.Object getWantRequestSigned() {
        return null;
    }

    /**
     * Property x509Certificate: The X.509 certificate n the PEM format. If you specify this parameter, all existing certificates are replaced.
     */
    default @org.jetbrains.annotations.Nullable java.lang.Object getX509Certificate() {
        return null;
    }

    /**
     * @return a {@link Builder} of {@link SAMLIdentityProviderProps}
     */
    static Builder builder() {
        return new Builder();
    }
    /**
     * A builder for {@link SAMLIdentityProviderProps}
     */
    public static final class Builder implements software.amazon.jsii.Builder {
        java.lang.Object directoryId;
        java.lang.Object encodedMetadataDocument;
        java.lang.Object entityId;
        java.lang.Object loginUrl;
        java.lang.Object ssoStatus;
        java.lang.Object wantRequestSigned;
        java.lang.Object x509Certificate;

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getDirectoryId}
         * @param directoryId Property directoryId: The ID of the directory. This parameter is required.
         * @return {@code this}
         */
        public Builder directoryId(java.lang.String directoryId) {
            this.directoryId = directoryId;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getDirectoryId}
         * @param directoryId Property directoryId: The ID of the directory. This parameter is required.
         * @return {@code this}
         */
        public Builder directoryId(com.aliyun.ros.cdk.core.IResolvable directoryId) {
            this.directoryId = directoryId;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getEncodedMetadataDocument}
         * @param encodedMetadataDocument Property encodedMetadataDocument: The metadata file of the IdP.
         *                                The value of this parameter is Base64-encoded.
         *                                The file is provided by the IdP that supports SAML 2.0.
         * @return {@code this}
         */
        public Builder encodedMetadataDocument(java.lang.String encodedMetadataDocument) {
            this.encodedMetadataDocument = encodedMetadataDocument;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getEncodedMetadataDocument}
         * @param encodedMetadataDocument Property encodedMetadataDocument: The metadata file of the IdP.
         *                                The value of this parameter is Base64-encoded.
         *                                The file is provided by the IdP that supports SAML 2.0.
         * @return {@code this}
         */
        public Builder encodedMetadataDocument(com.aliyun.ros.cdk.core.IResolvable encodedMetadataDocument) {
            this.encodedMetadataDocument = encodedMetadataDocument;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getEntityId}
         * @param entityId Property entityId: The entity ID of the IdP.
         * @return {@code this}
         */
        public Builder entityId(java.lang.String entityId) {
            this.entityId = entityId;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getEntityId}
         * @param entityId Property entityId: The entity ID of the IdP.
         * @return {@code this}
         */
        public Builder entityId(com.aliyun.ros.cdk.core.IResolvable entityId) {
            this.entityId = entityId;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getLoginUrl}
         * @param loginUrl Property loginUrl: The logon URL of the IdP.
         * @return {@code this}
         */
        public Builder loginUrl(java.lang.String loginUrl) {
            this.loginUrl = loginUrl;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getLoginUrl}
         * @param loginUrl Property loginUrl: The logon URL of the IdP.
         * @return {@code this}
         */
        public Builder loginUrl(com.aliyun.ros.cdk.core.IResolvable loginUrl) {
            this.loginUrl = loginUrl;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getSsoStatus}
         * @param ssoStatus Property ssoStatus: The status of SSO logon.
         *                  Valid values:
         *                  
         *                  

         *                  Enabled
         *                  Disabled (default)
         *                  
         * @return {@code this}
         */
        public Builder ssoStatus(java.lang.String ssoStatus) {
            this.ssoStatus = ssoStatus;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getSsoStatus}
         * @param ssoStatus Property ssoStatus: The status of SSO logon.
         *                  Valid values:
         *                  
         *                  

         *                  Enabled
         *                  Disabled (default)
         *                  
         * @return {@code this}
         */
        public Builder ssoStatus(com.aliyun.ros.cdk.core.IResolvable ssoStatus) {
            this.ssoStatus = ssoStatus;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getWantRequestSigned}
         * @param wantRequestSigned Property wantRequestSigned: Specifies whether CloudSSO needs to sign SAML requests.
         *                          The requests are sent when users log on to the CloudSSO user portal to initiate SAML-based SSO. Valid values:
         *                          
         *                          

         *                          true: yes
         *                          false: no (default)
         *                          
         * @return {@code this}
         */
        public Builder wantRequestSigned(java.lang.Boolean wantRequestSigned) {
            this.wantRequestSigned = wantRequestSigned;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getWantRequestSigned}
         * @param wantRequestSigned Property wantRequestSigned: Specifies whether CloudSSO needs to sign SAML requests.
         *                          The requests are sent when users log on to the CloudSSO user portal to initiate SAML-based SSO. Valid values:
         *                          
         *                          

         *                          true: yes
         *                          false: no (default)
         *                          
         * @return {@code this}
         */
        public Builder wantRequestSigned(com.aliyun.ros.cdk.core.IResolvable wantRequestSigned) {
            this.wantRequestSigned = wantRequestSigned;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getX509Certificate}
         * @param x509Certificate Property x509Certificate: The X.509 certificate n the PEM format. If you specify this parameter, all existing certificates are replaced.
         * @return {@code this}
         */
        public Builder x509Certificate(java.lang.String x509Certificate) {
            this.x509Certificate = x509Certificate;
            return this;
        }

        /**
         * Sets the value of {@link SAMLIdentityProviderProps#getX509Certificate}
         * @param x509Certificate Property x509Certificate: The X.509 certificate n the PEM format. If you specify this parameter, all existing certificates are replaced.
         * @return {@code this}
         */
        public Builder x509Certificate(com.aliyun.ros.cdk.core.IResolvable x509Certificate) {
            this.x509Certificate = x509Certificate;
            return this;
        }

        /**
         * Builds the configured instance.
         * @return a new instance of {@link SAMLIdentityProviderProps}
         * @throws NullPointerException if any required attribute was not provided
         */
        @Override
        public SAMLIdentityProviderProps build() {
            return new Jsii$Proxy(this);
        }
    }

    /**
     * An implementation for {@link SAMLIdentityProviderProps}
     */
    @software.amazon.jsii.Internal
    final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SAMLIdentityProviderProps {
        private final java.lang.Object directoryId;
        private final java.lang.Object encodedMetadataDocument;
        private final java.lang.Object entityId;
        private final java.lang.Object loginUrl;
        private final java.lang.Object ssoStatus;
        private final java.lang.Object wantRequestSigned;
        private final java.lang.Object x509Certificate;

        /**
         * Constructor that initializes the object based on values retrieved from the JsiiObject.
         * @param objRef Reference to the JSII managed object.
         */
        protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
            super(objRef);
            this.directoryId = software.amazon.jsii.Kernel.get(this, "directoryId", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
            this.encodedMetadataDocument = software.amazon.jsii.Kernel.get(this, "encodedMetadataDocument", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
            this.entityId = software.amazon.jsii.Kernel.get(this, "entityId", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
            this.loginUrl = software.amazon.jsii.Kernel.get(this, "loginUrl", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
            this.ssoStatus = software.amazon.jsii.Kernel.get(this, "ssoStatus", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
            this.wantRequestSigned = software.amazon.jsii.Kernel.get(this, "wantRequestSigned", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
            this.x509Certificate = software.amazon.jsii.Kernel.get(this, "x509Certificate", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
        }

        /**
         * Constructor that initializes the object based on literal property values passed by the {@link Builder}.
         */
        protected Jsii$Proxy(final Builder builder) {
            super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
            this.directoryId = java.util.Objects.requireNonNull(builder.directoryId, "directoryId is required");
            this.encodedMetadataDocument = builder.encodedMetadataDocument;
            this.entityId = builder.entityId;
            this.loginUrl = builder.loginUrl;
            this.ssoStatus = builder.ssoStatus;
            this.wantRequestSigned = builder.wantRequestSigned;
            this.x509Certificate = builder.x509Certificate;
        }

        @Override
        public final java.lang.Object getDirectoryId() {
            return this.directoryId;
        }

        @Override
        public final java.lang.Object getEncodedMetadataDocument() {
            return this.encodedMetadataDocument;
        }

        @Override
        public final java.lang.Object getEntityId() {
            return this.entityId;
        }

        @Override
        public final java.lang.Object getLoginUrl() {
            return this.loginUrl;
        }

        @Override
        public final java.lang.Object getSsoStatus() {
            return this.ssoStatus;
        }

        @Override
        public final java.lang.Object getWantRequestSigned() {
            return this.wantRequestSigned;
        }

        @Override
        public final java.lang.Object getX509Certificate() {
            return this.x509Certificate;
        }

        @Override
        @software.amazon.jsii.Internal
        public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
            final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
            final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();

            data.set("directoryId", om.valueToTree(this.getDirectoryId()));
            if (this.getEncodedMetadataDocument() != null) {
                data.set("encodedMetadataDocument", om.valueToTree(this.getEncodedMetadataDocument()));
            }
            if (this.getEntityId() != null) {
                data.set("entityId", om.valueToTree(this.getEntityId()));
            }
            if (this.getLoginUrl() != null) {
                data.set("loginUrl", om.valueToTree(this.getLoginUrl()));
            }
            if (this.getSsoStatus() != null) {
                data.set("ssoStatus", om.valueToTree(this.getSsoStatus()));
            }
            if (this.getWantRequestSigned() != null) {
                data.set("wantRequestSigned", om.valueToTree(this.getWantRequestSigned()));
            }
            if (this.getX509Certificate() != null) {
                data.set("x509Certificate", om.valueToTree(this.getX509Certificate()));
            }

            final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
            struct.set("fqn", om.valueToTree("@alicloud/ros-cdk-cloudsso.SAMLIdentityProviderProps"));
            struct.set("data", data);

            final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
            obj.set("$jsii.struct", struct);

            return obj;
        }

        @Override
        public final boolean equals(final Object o) {
            if (this == o) return true;
            if (o == null || getClass() != o.getClass()) return false;

            SAMLIdentityProviderProps.Jsii$Proxy that = (SAMLIdentityProviderProps.Jsii$Proxy) o;

            if (!directoryId.equals(that.directoryId)) return false;
            if (this.encodedMetadataDocument != null ? !this.encodedMetadataDocument.equals(that.encodedMetadataDocument) : that.encodedMetadataDocument != null) return false;
            if (this.entityId != null ? !this.entityId.equals(that.entityId) : that.entityId != null) return false;
            if (this.loginUrl != null ? !this.loginUrl.equals(that.loginUrl) : that.loginUrl != null) return false;
            if (this.ssoStatus != null ? !this.ssoStatus.equals(that.ssoStatus) : that.ssoStatus != null) return false;
            if (this.wantRequestSigned != null ? !this.wantRequestSigned.equals(that.wantRequestSigned) : that.wantRequestSigned != null) return false;
            return this.x509Certificate != null ? this.x509Certificate.equals(that.x509Certificate) : that.x509Certificate == null;
        }

        @Override
        public final int hashCode() {
            int result = this.directoryId.hashCode();
            result = 31 * result + (this.encodedMetadataDocument != null ? this.encodedMetadataDocument.hashCode() : 0);
            result = 31 * result + (this.entityId != null ? this.entityId.hashCode() : 0);
            result = 31 * result + (this.loginUrl != null ? this.loginUrl.hashCode() : 0);
            result = 31 * result + (this.ssoStatus != null ? this.ssoStatus.hashCode() : 0);
            result = 31 * result + (this.wantRequestSigned != null ? this.wantRequestSigned.hashCode() : 0);
            result = 31 * result + (this.x509Certificate != null ? this.x509Certificate.hashCode() : 0);
            return result;
        }
    }
}