com.amazonaws.services.batch.model.EFSAuthorizationConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-batch Show documentation
/*
* Copyright 2019-2024 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.batch.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The authorization configuration details for the Amazon EFS file system.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EFSAuthorizationConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
* EFSVolumeConfiguration must either be omitted or set to / which enforces the path set
* on the EFS access point. If an access point is used, transit encryption must be enabled in the
* EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points
* in the Amazon Elastic File System User Guide.
*
*/
private String accessPointId;
/**
*
* Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file
* system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this
* parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon
* EFS access points in the Batch User Guide. EFS IAM authorization requires that
* TransitEncryption be ENABLED and that a JobRoleArn is specified.
*
*/
private String iam;
/**
*
* The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
* EFSVolumeConfiguration must either be omitted or set to / which enforces the path set
* on the EFS access point. If an access point is used, transit encryption must be enabled in the
* EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points
* in the Amazon Elastic File System User Guide.
*
*
* @param accessPointId
* The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified
* in the EFSVolumeConfiguration must either be omitted or set to / which enforces
* the path set on the EFS access point. If an access point is used, transit encryption must be enabled in
* the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access
* points in the Amazon Elastic File System User Guide.
*/
public void setAccessPointId(String accessPointId) {
this.accessPointId = accessPointId;
}
/**
*
* The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
* EFSVolumeConfiguration must either be omitted or set to / which enforces the path set
* on the EFS access point. If an access point is used, transit encryption must be enabled in the
* EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points
* in the Amazon Elastic File System User Guide.
*
*
* @return The Amazon EFS access point ID to use. If an access point is specified, the root directory value
* specified in the EFSVolumeConfiguration must either be omitted or set to /
* which enforces the path set on the EFS access point. If an access point is used, transit encryption must
* be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access
* points in the Amazon Elastic File System User Guide.
*/
public String getAccessPointId() {
return this.accessPointId;
}
/**
*
* The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
* EFSVolumeConfiguration must either be omitted or set to / which enforces the path set
* on the EFS access point. If an access point is used, transit encryption must be enabled in the
* EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points
* in the Amazon Elastic File System User Guide.
*
*
* @param accessPointId
* The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified
* in the EFSVolumeConfiguration must either be omitted or set to / which enforces
* the path set on the EFS access point. If an access point is used, transit encryption must be enabled in
* the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access
* points in the Amazon Elastic File System User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EFSAuthorizationConfig withAccessPointId(String accessPointId) {
setAccessPointId(accessPointId);
return this;
}
/**
*
* Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file
* system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this
* parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon
* EFS access points in the Batch User Guide. EFS IAM authorization requires that
* TransitEncryption be ENABLED and that a JobRoleArn is specified.
*
*
* @param iam
* Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file
* system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this
* parameter is omitted, the default value of DISABLED is used. For more information, see Using
* Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that
* TransitEncryption be ENABLED and that a JobRoleArn is specified.
* @see EFSAuthorizationConfigIAM
*/
public void setIam(String iam) {
this.iam = iam;
}
/**
*
* Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file
* system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this
* parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon
* EFS access points in the Batch User Guide. EFS IAM authorization requires that
* TransitEncryption be ENABLED and that a JobRoleArn is specified.
*
*
* @return Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS
* file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration.
* If this parameter is omitted, the default value of DISABLED is used. For more information,
* see Using
* Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that
* TransitEncryption be ENABLED and that a JobRoleArn is specified.
* @see EFSAuthorizationConfigIAM
*/
public String getIam() {
return this.iam;
}
/**
*
* Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file
* system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this
* parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon
* EFS access points in the Batch User Guide. EFS IAM authorization requires that
* TransitEncryption be ENABLED and that a JobRoleArn is specified.
*
*
* @param iam
* Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file
* system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this
* parameter is omitted, the default value of DISABLED is used. For more information, see Using
* Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that
* TransitEncryption be ENABLED and that a JobRoleArn is specified.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EFSAuthorizationConfigIAM
*/
public EFSAuthorizationConfig withIam(String iam) {
setIam(iam);
return this;
}
/**
*
* Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file
* system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this
* parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon
* EFS access points in the Batch User Guide. EFS IAM authorization requires that
* TransitEncryption be ENABLED and that a JobRoleArn is specified.
*
*
* @param iam
* Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file
* system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this
* parameter is omitted, the default value of DISABLED is used. For more information, see Using
* Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that
* TransitEncryption be ENABLED and that a JobRoleArn is specified.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EFSAuthorizationConfigIAM
*/
public EFSAuthorizationConfig withIam(EFSAuthorizationConfigIAM iam) {
this.iam = iam.toString();
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 (getAccessPointId() != null)
sb.append("AccessPointId: ").append(getAccessPointId()).append(",");
if (getIam() != null)
sb.append("Iam: ").append(getIam());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EFSAuthorizationConfig == false)
return false;
EFSAuthorizationConfig other = (EFSAuthorizationConfig) obj;
if (other.getAccessPointId() == null ^ this.getAccessPointId() == null)
return false;
if (other.getAccessPointId() != null && other.getAccessPointId().equals(this.getAccessPointId()) == false)
return false;
if (other.getIam() == null ^ this.getIam() == null)
return false;
if (other.getIam() != null && other.getIam().equals(this.getIam()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccessPointId() == null) ? 0 : getAccessPointId().hashCode());
hashCode = prime * hashCode + ((getIam() == null) ? 0 : getIam().hashCode());
return hashCode;
}
@Override
public EFSAuthorizationConfig clone() {
try {
return (EFSAuthorizationConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.batch.model.transform.EFSAuthorizationConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}