com.amazonaws.services.identitymanagement.model.CreateServiceLinkedRoleRequest 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 CreateServiceLinkedRoleRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The service principal for the Amazon Web Services service to which this role is attached. You use a string
* similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.
*
*
* Service principals are unique and case-sensitive. To find the exact service principal for your service-linked
* role, see Amazon Web
* Services services that work with IAM in the IAM User Guide. Look for the services that have Yes
* in the Service-Linked Role column. Choose the Yes link to view the service-linked role
* documentation for that service.
*
*/
private String aWSServiceName;
/**
*
* The description of the role.
*
*/
private String description;
/**
*
*
* A string that you provide, which is combined with the service-provided prefix to form the complete role name. If
* you make multiple requests for the same service, then you must supply a different CustomSuffix for
* each request. Otherwise the request fails with a duplicate role name error. For example, you could add
* -1 or -debug to the suffix.
*
*
* Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the
* operation fails, try the operation again without the suffix.
*
*/
private String customSuffix;
/**
*
* The service principal for the Amazon Web Services service to which this role is attached. You use a string
* similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.
*
*
* Service principals are unique and case-sensitive. To find the exact service principal for your service-linked
* role, see Amazon Web
* Services services that work with IAM in the IAM User Guide. Look for the services that have Yes
* in the Service-Linked Role column. Choose the Yes link to view the service-linked role
* documentation for that service.
*
*
* @param aWSServiceName
* The service principal for the Amazon Web Services service to which this role is attached. You use a string
* similar to a URL but without the http:// in front. For example:
* elasticbeanstalk.amazonaws.com.
*
* Service principals are unique and case-sensitive. To find the exact service principal for your
* service-linked role, see Amazon Web Services services that work with IAM in the IAM User Guide. Look for the services
* that have Yes in the Service-Linked Role column. Choose the Yes link to view the
* service-linked role documentation for that service.
*/
public void setAWSServiceName(String aWSServiceName) {
this.aWSServiceName = aWSServiceName;
}
/**
*
* The service principal for the Amazon Web Services service to which this role is attached. You use a string
* similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.
*
*
* Service principals are unique and case-sensitive. To find the exact service principal for your service-linked
* role, see Amazon Web
* Services services that work with IAM in the IAM User Guide. Look for the services that have Yes
* in the Service-Linked Role column. Choose the Yes link to view the service-linked role
* documentation for that service.
*
*
* @return The service principal for the Amazon Web Services service to which this role is attached. You use a
* string similar to a URL but without the http:// in front. For example:
* elasticbeanstalk.amazonaws.com.
*
* Service principals are unique and case-sensitive. To find the exact service principal for your
* service-linked role, see Amazon Web Services services that work with IAM in the IAM User Guide. Look for the services
* that have Yes in the Service-Linked Role column. Choose the Yes link to view the
* service-linked role documentation for that service.
*/
public String getAWSServiceName() {
return this.aWSServiceName;
}
/**
*
* The service principal for the Amazon Web Services service to which this role is attached. You use a string
* similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.
*
*
* Service principals are unique and case-sensitive. To find the exact service principal for your service-linked
* role, see Amazon Web
* Services services that work with IAM in the IAM User Guide. Look for the services that have Yes
* in the Service-Linked Role column. Choose the Yes link to view the service-linked role
* documentation for that service.
*
*
* @param aWSServiceName
* The service principal for the Amazon Web Services service to which this role is attached. You use a string
* similar to a URL but without the http:// in front. For example:
* elasticbeanstalk.amazonaws.com.
*
* Service principals are unique and case-sensitive. To find the exact service principal for your
* service-linked role, see Amazon Web Services services that work with IAM in the IAM User Guide. Look for the services
* that have Yes in the Service-Linked Role column. Choose the Yes link to view the
* service-linked role documentation for that service.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceLinkedRoleRequest withAWSServiceName(String aWSServiceName) {
setAWSServiceName(aWSServiceName);
return this;
}
/**
*
* The description of the role.
*
*
* @param description
* The description of the role.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the role.
*
*
* @return The description of the role.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the role.
*
*
* @param description
* The description of the role.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceLinkedRoleRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
*
* A string that you provide, which is combined with the service-provided prefix to form the complete role name. If
* you make multiple requests for the same service, then you must supply a different CustomSuffix for
* each request. Otherwise the request fails with a duplicate role name error. For example, you could add
* -1 or -debug to the suffix.
*
*
* Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the
* operation fails, try the operation again without the suffix.
*
*
* @param customSuffix
*
* A string that you provide, which is combined with the service-provided prefix to form the complete role
* name. If you make multiple requests for the same service, then you must supply a different
* CustomSuffix for each request. Otherwise the request fails with a duplicate role name error.
* For example, you could add -1 or -debug to the suffix.
*
*
* Some services do not support the CustomSuffix parameter. If you provide an optional suffix
* and the operation fails, try the operation again without the suffix.
*/
public void setCustomSuffix(String customSuffix) {
this.customSuffix = customSuffix;
}
/**
*
*
* A string that you provide, which is combined with the service-provided prefix to form the complete role name. If
* you make multiple requests for the same service, then you must supply a different CustomSuffix for
* each request. Otherwise the request fails with a duplicate role name error. For example, you could add
* -1 or -debug to the suffix.
*
*
* Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the
* operation fails, try the operation again without the suffix.
*
*
* @return
* A string that you provide, which is combined with the service-provided prefix to form the complete role
* name. If you make multiple requests for the same service, then you must supply a different
* CustomSuffix for each request. Otherwise the request fails with a duplicate role name error.
* For example, you could add -1 or -debug to the suffix.
*
*
* Some services do not support the CustomSuffix parameter. If you provide an optional suffix
* and the operation fails, try the operation again without the suffix.
*/
public String getCustomSuffix() {
return this.customSuffix;
}
/**
*
*
* A string that you provide, which is combined with the service-provided prefix to form the complete role name. If
* you make multiple requests for the same service, then you must supply a different CustomSuffix for
* each request. Otherwise the request fails with a duplicate role name error. For example, you could add
* -1 or -debug to the suffix.
*
*
* Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the
* operation fails, try the operation again without the suffix.
*
*
* @param customSuffix
*
* A string that you provide, which is combined with the service-provided prefix to form the complete role
* name. If you make multiple requests for the same service, then you must supply a different
* CustomSuffix for each request. Otherwise the request fails with a duplicate role name error.
* For example, you could add -1 or -debug to the suffix.
*
*
* Some services do not support the CustomSuffix parameter. If you provide an optional suffix
* and the operation fails, try the operation again without the suffix.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceLinkedRoleRequest withCustomSuffix(String customSuffix) {
setCustomSuffix(customSuffix);
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 (getAWSServiceName() != null)
sb.append("AWSServiceName: ").append(getAWSServiceName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getCustomSuffix() != null)
sb.append("CustomSuffix: ").append(getCustomSuffix());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateServiceLinkedRoleRequest == false)
return false;
CreateServiceLinkedRoleRequest other = (CreateServiceLinkedRoleRequest) obj;
if (other.getAWSServiceName() == null ^ this.getAWSServiceName() == null)
return false;
if (other.getAWSServiceName() != null && other.getAWSServiceName().equals(this.getAWSServiceName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getCustomSuffix() == null ^ this.getCustomSuffix() == null)
return false;
if (other.getCustomSuffix() != null && other.getCustomSuffix().equals(this.getCustomSuffix()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAWSServiceName() == null) ? 0 : getAWSServiceName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getCustomSuffix() == null) ? 0 : getCustomSuffix().hashCode());
return hashCode;
}
@Override
public CreateServiceLinkedRoleRequest clone() {
return (CreateServiceLinkedRoleRequest) super.clone();
}
}