com.amazonaws.services.sagemaker.model.ClusterLifeCycleConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The lifecycle configuration for a SageMaker HyperPod cluster.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ClusterLifeCycleConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* An Amazon S3 bucket path where your lifecycle scripts are stored.
*
*
*
* Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed
* AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the
* specific prefix sagemaker-.
*
*
*/
private String sourceS3Uri;
/**
*
* The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint
* script runs during cluster creation.
*
*/
private String onCreate;
/**
*
* An Amazon S3 bucket path where your lifecycle scripts are stored.
*
*
*
* Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed
* AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the
* specific prefix sagemaker-.
*
*
*
* @param sourceS3Uri
* An Amazon S3 bucket path where your lifecycle scripts are stored.
*
* Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed
* AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets
* with the specific prefix sagemaker-.
*
*/
public void setSourceS3Uri(String sourceS3Uri) {
this.sourceS3Uri = sourceS3Uri;
}
/**
*
* An Amazon S3 bucket path where your lifecycle scripts are stored.
*
*
*
* Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed
* AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the
* specific prefix sagemaker-.
*
*
*
* @return An Amazon S3 bucket path where your lifecycle scripts are stored.
*
* Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed
* AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets
* with the specific prefix sagemaker-.
*
*/
public String getSourceS3Uri() {
return this.sourceS3Uri;
}
/**
*
* An Amazon S3 bucket path where your lifecycle scripts are stored.
*
*
*
* Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed
* AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the
* specific prefix sagemaker-.
*
*
*
* @param sourceS3Uri
* An Amazon S3 bucket path where your lifecycle scripts are stored.
*
* Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed
* AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets
* with the specific prefix sagemaker-.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClusterLifeCycleConfig withSourceS3Uri(String sourceS3Uri) {
setSourceS3Uri(sourceS3Uri);
return this;
}
/**
*
* The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint
* script runs during cluster creation.
*
*
* @param onCreate
* The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This
* entrypoint script runs during cluster creation.
*/
public void setOnCreate(String onCreate) {
this.onCreate = onCreate;
}
/**
*
* The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint
* script runs during cluster creation.
*
*
* @return The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This
* entrypoint script runs during cluster creation.
*/
public String getOnCreate() {
return this.onCreate;
}
/**
*
* The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint
* script runs during cluster creation.
*
*
* @param onCreate
* The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This
* entrypoint script runs during cluster creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClusterLifeCycleConfig withOnCreate(String onCreate) {
setOnCreate(onCreate);
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 (getSourceS3Uri() != null)
sb.append("SourceS3Uri: ").append(getSourceS3Uri()).append(",");
if (getOnCreate() != null)
sb.append("OnCreate: ").append(getOnCreate());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ClusterLifeCycleConfig == false)
return false;
ClusterLifeCycleConfig other = (ClusterLifeCycleConfig) obj;
if (other.getSourceS3Uri() == null ^ this.getSourceS3Uri() == null)
return false;
if (other.getSourceS3Uri() != null && other.getSourceS3Uri().equals(this.getSourceS3Uri()) == false)
return false;
if (other.getOnCreate() == null ^ this.getOnCreate() == null)
return false;
if (other.getOnCreate() != null && other.getOnCreate().equals(this.getOnCreate()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSourceS3Uri() == null) ? 0 : getSourceS3Uri().hashCode());
hashCode = prime * hashCode + ((getOnCreate() == null) ? 0 : getOnCreate().hashCode());
return hashCode;
}
@Override
public ClusterLifeCycleConfig clone() {
try {
return (ClusterLifeCycleConfig) 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.sagemaker.model.transform.ClusterLifeCycleConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}