com.amazonaws.services.identitymanagement.model.CreateSAMLProviderRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iam Show documentation
/*
* Copyright 2020-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.identitymanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateSAMLProviderRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication response
* (assertions) that are received from the IdP. You must generate the metadata document using the identity
* management software that is used as your organization's IdP.
*
*
* For more information, see About SAML 2.0-based
* federation in the IAM User Guide
*
*/
private String sAMLMetadataDocument;
/**
*
* The name of the provider to create.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*/
private String name;
/**
*
* A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an
* associated value. For more information about tagging, see Tagging IAM resources in the IAM User
* Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request
* fails and the resource is not created.
*
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication response
* (assertions) that are received from the IdP. You must generate the metadata document using the identity
* management software that is used as your organization's IdP.
*
*
* For more information, see About SAML 2.0-based
* federation in the IAM User Guide
*
*
* @param sAMLMetadataDocument
* An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication
* response (assertions) that are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.
*
* For more information, see About SAML 2.0-based
* federation in the IAM User Guide
*/
public void setSAMLMetadataDocument(String sAMLMetadataDocument) {
this.sAMLMetadataDocument = sAMLMetadataDocument;
}
/**
*
* An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication response
* (assertions) that are received from the IdP. You must generate the metadata document using the identity
* management software that is used as your organization's IdP.
*
*
* For more information, see About SAML 2.0-based
* federation in the IAM User Guide
*
*
* @return An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication
* response (assertions) that are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.
*
* For more information, see About SAML 2.0-based
* federation in the IAM User Guide
*/
public String getSAMLMetadataDocument() {
return this.sAMLMetadataDocument;
}
/**
*
* An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication response
* (assertions) that are received from the IdP. You must generate the metadata document using the identity
* management software that is used as your organization's IdP.
*
*
* For more information, see About SAML 2.0-based
* federation in the IAM User Guide
*
*
* @param sAMLMetadataDocument
* An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication
* response (assertions) that are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.
*
* For more information, see About SAML 2.0-based
* federation in the IAM User Guide
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSAMLProviderRequest withSAMLMetadataDocument(String sAMLMetadataDocument) {
setSAMLMetadataDocument(sAMLMetadataDocument);
return this;
}
/**
*
* The name of the provider to create.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*
* @param name
* The name of the provider to create.
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also
* include any of the following characters: _+=,.@-
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the provider to create.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*
* @return The name of the provider to create.
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also
* include any of the following characters: _+=,.@-
*/
public String getName() {
return this.name;
}
/**
*
* The name of the provider to create.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*
* @param name
* The name of the provider to create.
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also
* include any of the following characters: _+=,.@-
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSAMLProviderRequest withName(String name) {
setName(name);
return this;
}
/**
*
* A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an
* associated value. For more information about tagging, see Tagging IAM resources in the IAM User
* Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request
* fails and the resource is not created.
*
*
*
* @return A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and
* an associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an
* associated value. For more information about tagging, see Tagging IAM resources in the IAM User
* Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request
* fails and the resource is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and
* an associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an
* associated value. For more information about tagging, see Tagging IAM resources in the IAM User
* Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request
* fails and the resource is not created.
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and
* an associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSAMLProviderRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an
* associated value. For more information about tagging, see Tagging IAM resources in the IAM User
* Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request
* fails and the resource is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and
* an associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSAMLProviderRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSAMLMetadataDocument() != null)
sb.append("SAMLMetadataDocument: ").append(getSAMLMetadataDocument()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateSAMLProviderRequest == false)
return false;
CreateSAMLProviderRequest other = (CreateSAMLProviderRequest) obj;
if (other.getSAMLMetadataDocument() == null ^ this.getSAMLMetadataDocument() == null)
return false;
if (other.getSAMLMetadataDocument() != null && other.getSAMLMetadataDocument().equals(this.getSAMLMetadataDocument()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSAMLMetadataDocument() == null) ? 0 : getSAMLMetadataDocument().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateSAMLProviderRequest clone() {
return (CreateSAMLProviderRequest) super.clone();
}
}