software.amazon.awssdk.services.sagemaker.model.ClusterLifeCycleConfig Maven / Gradle / Ivy
Show all versions of sagemaker Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.sagemaker.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The lifecycle configuration for a SageMaker HyperPod cluster.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ClusterLifeCycleConfig implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField SOURCE_S3_URI_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceS3Uri").getter(getter(ClusterLifeCycleConfig::sourceS3Uri)).setter(setter(Builder::sourceS3Uri))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceS3Uri").build()).build();
private static final SdkField ON_CREATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OnCreate").getter(getter(ClusterLifeCycleConfig::onCreate)).setter(setter(Builder::onCreate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OnCreate").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SOURCE_S3_URI_FIELD,
ON_CREATE_FIELD));
private static final long serialVersionUID = 1L;
private final String sourceS3Uri;
private final String onCreate;
private ClusterLifeCycleConfig(BuilderImpl builder) {
this.sourceS3Uri = builder.sourceS3Uri;
this.onCreate = builder.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-.
*
*
*
* @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 final String sourceS3Uri() {
return sourceS3Uri;
}
/**
*
* 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 final String onCreate() {
return onCreate;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(sourceS3Uri());
hashCode = 31 * hashCode + Objects.hashCode(onCreate());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ClusterLifeCycleConfig)) {
return false;
}
ClusterLifeCycleConfig other = (ClusterLifeCycleConfig) obj;
return Objects.equals(sourceS3Uri(), other.sourceS3Uri()) && Objects.equals(onCreate(), other.onCreate());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ClusterLifeCycleConfig").add("SourceS3Uri", sourceS3Uri()).add("OnCreate", onCreate()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SourceS3Uri":
return Optional.ofNullable(clazz.cast(sourceS3Uri()));
case "OnCreate":
return Optional.ofNullable(clazz.cast(onCreate()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ClusterLifeCycleConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder sourceS3Uri(String sourceS3Uri);
/**
*
* 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.
*/
Builder onCreate(String onCreate);
}
static final class BuilderImpl implements Builder {
private String sourceS3Uri;
private String onCreate;
private BuilderImpl() {
}
private BuilderImpl(ClusterLifeCycleConfig model) {
sourceS3Uri(model.sourceS3Uri);
onCreate(model.onCreate);
}
public final String getSourceS3Uri() {
return sourceS3Uri;
}
public final void setSourceS3Uri(String sourceS3Uri) {
this.sourceS3Uri = sourceS3Uri;
}
@Override
public final Builder sourceS3Uri(String sourceS3Uri) {
this.sourceS3Uri = sourceS3Uri;
return this;
}
public final String getOnCreate() {
return onCreate;
}
public final void setOnCreate(String onCreate) {
this.onCreate = onCreate;
}
@Override
public final Builder onCreate(String onCreate) {
this.onCreate = onCreate;
return this;
}
@Override
public ClusterLifeCycleConfig build() {
return new ClusterLifeCycleConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}