com.amazonaws.services.kinesisfirehose.model.SecretsManagerConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis 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.kinesisfirehose.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The structure that defines how Firehose accesses the secret.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SecretsManagerConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the
* role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports
* cross-account secret access. This parameter is required when Enabled is set to True.
*
*/
private String secretARN;
/**
*
* Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the
* role, it overrides any destination specific role defined in the destination configuration. If you do not provide
* the then we use the destination specific role. This parameter is required for Splunk.
*
*/
private String roleARN;
/**
*
* Specifies whether you want to use the the secrets manager feature. When set as True the secrets
* manager configuration overwrites the existing secrets in the destination configuration. When it's set to
* False Firehose falls back to the credentials in the destination configuration.
*
*/
private Boolean enabled;
/**
*
* The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the
* role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports
* cross-account secret access. This parameter is required when Enabled is set to True.
*
*
* @param secretARN
* The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream
* and the role. The secret ARN can reside in a different account than the delivery stream and role as
* Firehose supports cross-account secret access. This parameter is required when Enabled is set to
* True.
*/
public void setSecretARN(String secretARN) {
this.secretARN = secretARN;
}
/**
*
* The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the
* role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports
* cross-account secret access. This parameter is required when Enabled is set to True.
*
*
* @return The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream
* and the role. The secret ARN can reside in a different account than the delivery stream and role as
* Firehose supports cross-account secret access. This parameter is required when Enabled is set to
* True.
*/
public String getSecretARN() {
return this.secretARN;
}
/**
*
* The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the
* role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports
* cross-account secret access. This parameter is required when Enabled is set to True.
*
*
* @param secretARN
* The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream
* and the role. The secret ARN can reside in a different account than the delivery stream and role as
* Firehose supports cross-account secret access. This parameter is required when Enabled is set to
* True.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SecretsManagerConfiguration withSecretARN(String secretARN) {
setSecretARN(secretARN);
return this;
}
/**
*
* Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the
* role, it overrides any destination specific role defined in the destination configuration. If you do not provide
* the then we use the destination specific role. This parameter is required for Splunk.
*
*
* @param roleARN
* Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide
* the role, it overrides any destination specific role defined in the destination configuration. If you do
* not provide the then we use the destination specific role. This parameter is required for Splunk.
*/
public void setRoleARN(String roleARN) {
this.roleARN = roleARN;
}
/**
*
* Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the
* role, it overrides any destination specific role defined in the destination configuration. If you do not provide
* the then we use the destination specific role. This parameter is required for Splunk.
*
*
* @return Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide
* the role, it overrides any destination specific role defined in the destination configuration. If you do
* not provide the then we use the destination specific role. This parameter is required for Splunk.
*/
public String getRoleARN() {
return this.roleARN;
}
/**
*
* Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the
* role, it overrides any destination specific role defined in the destination configuration. If you do not provide
* the then we use the destination specific role. This parameter is required for Splunk.
*
*
* @param roleARN
* Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide
* the role, it overrides any destination specific role defined in the destination configuration. If you do
* not provide the then we use the destination specific role. This parameter is required for Splunk.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SecretsManagerConfiguration withRoleARN(String roleARN) {
setRoleARN(roleARN);
return this;
}
/**
*
* Specifies whether you want to use the the secrets manager feature. When set as True the secrets
* manager configuration overwrites the existing secrets in the destination configuration. When it's set to
* False Firehose falls back to the credentials in the destination configuration.
*
*
* @param enabled
* Specifies whether you want to use the the secrets manager feature. When set as True the
* secrets manager configuration overwrites the existing secrets in the destination configuration. When it's
* set to False Firehose falls back to the credentials in the destination configuration.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
*
* Specifies whether you want to use the the secrets manager feature. When set as True the secrets
* manager configuration overwrites the existing secrets in the destination configuration. When it's set to
* False Firehose falls back to the credentials in the destination configuration.
*
*
* @return Specifies whether you want to use the the secrets manager feature. When set as True the
* secrets manager configuration overwrites the existing secrets in the destination configuration. When it's
* set to False Firehose falls back to the credentials in the destination configuration.
*/
public Boolean getEnabled() {
return this.enabled;
}
/**
*
* Specifies whether you want to use the the secrets manager feature. When set as True the secrets
* manager configuration overwrites the existing secrets in the destination configuration. When it's set to
* False Firehose falls back to the credentials in the destination configuration.
*
*
* @param enabled
* Specifies whether you want to use the the secrets manager feature. When set as True the
* secrets manager configuration overwrites the existing secrets in the destination configuration. When it's
* set to False Firehose falls back to the credentials in the destination configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SecretsManagerConfiguration withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
*
* Specifies whether you want to use the the secrets manager feature. When set as True the secrets
* manager configuration overwrites the existing secrets in the destination configuration. When it's set to
* False Firehose falls back to the credentials in the destination configuration.
*
*
* @return Specifies whether you want to use the the secrets manager feature. When set as True the
* secrets manager configuration overwrites the existing secrets in the destination configuration. When it's
* set to False Firehose falls back to the credentials in the destination configuration.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
* 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 (getSecretARN() != null)
sb.append("SecretARN: ").append(getSecretARN()).append(",");
if (getRoleARN() != null)
sb.append("RoleARN: ").append(getRoleARN()).append(",");
if (getEnabled() != null)
sb.append("Enabled: ").append(getEnabled());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SecretsManagerConfiguration == false)
return false;
SecretsManagerConfiguration other = (SecretsManagerConfiguration) obj;
if (other.getSecretARN() == null ^ this.getSecretARN() == null)
return false;
if (other.getSecretARN() != null && other.getSecretARN().equals(this.getSecretARN()) == false)
return false;
if (other.getRoleARN() == null ^ this.getRoleARN() == null)
return false;
if (other.getRoleARN() != null && other.getRoleARN().equals(this.getRoleARN()) == false)
return false;
if (other.getEnabled() == null ^ this.getEnabled() == null)
return false;
if (other.getEnabled() != null && other.getEnabled().equals(this.getEnabled()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSecretARN() == null) ? 0 : getSecretARN().hashCode());
hashCode = prime * hashCode + ((getRoleARN() == null) ? 0 : getRoleARN().hashCode());
hashCode = prime * hashCode + ((getEnabled() == null) ? 0 : getEnabled().hashCode());
return hashCode;
}
@Override
public SecretsManagerConfiguration clone() {
try {
return (SecretsManagerConfiguration) 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.kinesisfirehose.model.transform.SecretsManagerConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}