com.amazonaws.services.s3.model.BucketReplicationConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-s3 Show documentation
Show all versions of aws-java-sdk-s3 Show documentation
The AWS Java SDK for Amazon S3 module holds the client classes that are used for communicating with Amazon Simple Storage Service
The newest version!
/*
* Copyright 2015-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.s3.model;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import com.amazonaws.util.json.Jackson;
/**
* Replication configuration for an Amazon S3 bucket.
*/
public class BucketReplicationConfiguration implements Serializable {
/** The ARN of the IAM role that Amazon S3 assumes while replication. */
private String roleARN;
/** Collection of replication rules associated with the Amazon S3 bucket. */
private Map rules = new HashMap();
/**
* Returns the IAM role associated with this replication configuration.
*/
public String getRoleARN() {
return roleARN;
}
/**
* Sets the IAM role that will be used by Amazon S3 while replication.
*
* @param role
* The IAM role for this configuration.
*/
public void setRoleARN(String roleARN) {
this.roleARN = roleARN;
}
/**
* Sets the IAM role that will be used by Amazon S3 while replication.
* Returns the updated object.
*
* @param roleARN
* The IAM role for this configuration.
* @return The updated {@link BucketReplicationConfiguration} object.
*/
public BucketReplicationConfiguration withRoleARN(String roleARN) {
setRoleARN(roleARN);
return this;
}
/**
* Returns the replication rules associated with this Amazon S3 bucket.
*
* @return the replication rules associated with this Amazon S3 bucket.
*/
public Map getRules() {
return rules;
}
/**
* Returns the replication rule for the given rule id.
*
* @param id
* the unique identifier representing a rule in the replication
* configuration.
* @return the replication rule for the given rule id.
*/
public ReplicationRule getRule(String id) {
return rules.get(id);
}
/**
* Sets the replication rules for the Amazon S3 bucket.
*
* @param rules
* the replication rules for the Amazon S3 bucket.
* @throws IllegalArgumentException
* if the rules are null.
*/
public void setRules(Map rules) {
if (rules == null) {
throw new IllegalArgumentException(
"Replication rules cannot be null");
}
this.rules = new HashMap(rules);
}
/**
* Sets the replication rules for the Amazon S3 bucket. Returns the updated
* object.
*
* @param rules
* the replication rules for the Amazon S3 bucket.
* @throws IllegalArgumentException
* if the rules are null.
* @return the updated {@link BucketReplicationConfiguration} object.
*/
public BucketReplicationConfiguration withRules(
Map rules) {
setRules(rules);
return this;
}
/**
* Adds a new rule to the replication configuration associated with this
* Amazon S3 bucket. Returns the updated object.
*
* @param id
* the id for the rule.
* @param rule
* the replication rule for the Amazon S3 bucket.
* @throws IllegalArgumentException
* if the given id or rule is null.
* @return the updated {@link BucketReplicationConfiguration} object.
*/
public BucketReplicationConfiguration addRule(String id,
ReplicationRule rule) {
if (id == null || id.trim().isEmpty()) {
throw new IllegalArgumentException(
"Rule id cannot be null or empty.");
}
if (rule == null) {
throw new IllegalArgumentException(
"Replication rule cannot be null");
}
rules.put(id, rule);
return this;
}
/**
* Removes the replication rule with the given id from the replication
* configuration associated with Amazon S3 bucket. Returns the updated
* object.
*
* @param id
* the id of the replication rule to be removed.
* @return the updated {@link BucketReplicationConfiguration} object.
*/
public BucketReplicationConfiguration removeRule(String id) {
rules.remove(id);
return this;
}
@Override
public String toString() {
return Jackson.toJsonString(this);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy