com.amazonaws.services.synthetics.model.UpdateCanaryRequest Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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.synthetics.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateCanaryRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
*
*
* You cannot change the name of a canary that has already been created.
*
*/
private String name;
/**
*
* A structure that includes the entry point from which the canary should start running your script. If the script
* is stored in an S3 bucket, the bucket name, key, and version are also included.
*
*/
private CanaryCodeInput code;
/**
*
* The ARN of the IAM role to be used to run the canary. This role must already exist, and must include
* lambda.amazonaws.com as a principal in the trust policy. The role must also have the following
* permissions:
*
*
* -
*
* s3:PutObject
*
*
* -
*
* s3:GetBucketLocation
*
*
* -
*
* s3:ListAllMyBuckets
*
*
* -
*
* cloudwatch:PutMetricData
*
*
* -
*
* logs:CreateLogGroup
*
*
* -
*
* logs:CreateLogStream
*
*
* -
*
* logs:CreateLogStream
*
*
*
*/
private String executionRoleArn;
/**
*
* Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For
* more information about runtime versions, see
* Canary Runtime Versions.
*
*/
private String runtimeVersion;
/**
*
* A structure that contains information about how often the canary is to run, and when these runs are to stop.
*
*/
private CanaryScheduleInput schedule;
/**
*
* A structure that contains the timeout value that is used for each individual run of the canary.
*
*/
private CanaryRunConfigInput runConfig;
/**
*
* The number of days to retain data about successful runs of this canary.
*
*/
private Integer successRetentionPeriodInDays;
/**
*
* The number of days to retain data about failed runs of this canary.
*
*/
private Integer failureRetentionPeriodInDays;
/**
*
* If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security
* groups of the VPC endpoint. For more information, see
* Running a Canary in a VPC.
*
*/
private VpcConfigInput vpcConfig;
/**
*
* The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
*
*
* You cannot change the name of a canary that has already been created.
*
*
* @param name
* The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
*
* You cannot change the name of a canary that has already been created.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
*
*
* You cannot change the name of a canary that has already been created.
*
*
* @return The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
*
* You cannot change the name of a canary that has already been created.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
*
*
* You cannot change the name of a canary that has already been created.
*
*
* @param name
* The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
*
* You cannot change the name of a canary that has already been created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateCanaryRequest withName(String name) {
setName(name);
return this;
}
/**
*
* A structure that includes the entry point from which the canary should start running your script. If the script
* is stored in an S3 bucket, the bucket name, key, and version are also included.
*
*
* @param code
* A structure that includes the entry point from which the canary should start running your script. If the
* script is stored in an S3 bucket, the bucket name, key, and version are also included.
*/
public void setCode(CanaryCodeInput code) {
this.code = code;
}
/**
*
* A structure that includes the entry point from which the canary should start running your script. If the script
* is stored in an S3 bucket, the bucket name, key, and version are also included.
*
*
* @return A structure that includes the entry point from which the canary should start running your script. If the
* script is stored in an S3 bucket, the bucket name, key, and version are also included.
*/
public CanaryCodeInput getCode() {
return this.code;
}
/**
*
* A structure that includes the entry point from which the canary should start running your script. If the script
* is stored in an S3 bucket, the bucket name, key, and version are also included.
*
*
* @param code
* A structure that includes the entry point from which the canary should start running your script. If the
* script is stored in an S3 bucket, the bucket name, key, and version are also included.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateCanaryRequest withCode(CanaryCodeInput code) {
setCode(code);
return this;
}
/**
*
* The ARN of the IAM role to be used to run the canary. This role must already exist, and must include
* lambda.amazonaws.com as a principal in the trust policy. The role must also have the following
* permissions:
*
*
* -
*
* s3:PutObject
*
*
* -
*
* s3:GetBucketLocation
*
*
* -
*
* s3:ListAllMyBuckets
*
*
* -
*
* cloudwatch:PutMetricData
*
*
* -
*
* logs:CreateLogGroup
*
*
* -
*
* logs:CreateLogStream
*
*
* -
*
* logs:CreateLogStream
*
*
*
*
* @param executionRoleArn
* The ARN of the IAM role to be used to run the canary. This role must already exist, and must include
* lambda.amazonaws.com as a principal in the trust policy. The role must also have the
* following permissions:
*
* -
*
* s3:PutObject
*
*
* -
*
* s3:GetBucketLocation
*
*
* -
*
* s3:ListAllMyBuckets
*
*
* -
*
* cloudwatch:PutMetricData
*
*
* -
*
* logs:CreateLogGroup
*
*
* -
*
* logs:CreateLogStream
*
*
* -
*
* logs:CreateLogStream
*
*
*/
public void setExecutionRoleArn(String executionRoleArn) {
this.executionRoleArn = executionRoleArn;
}
/**
*
* The ARN of the IAM role to be used to run the canary. This role must already exist, and must include
* lambda.amazonaws.com as a principal in the trust policy. The role must also have the following
* permissions:
*
*
* -
*
* s3:PutObject
*
*
* -
*
* s3:GetBucketLocation
*
*
* -
*
* s3:ListAllMyBuckets
*
*
* -
*
* cloudwatch:PutMetricData
*
*
* -
*
* logs:CreateLogGroup
*
*
* -
*
* logs:CreateLogStream
*
*
* -
*
* logs:CreateLogStream
*
*
*
*
* @return The ARN of the IAM role to be used to run the canary. This role must already exist, and must include
* lambda.amazonaws.com as a principal in the trust policy. The role must also have the
* following permissions:
*
* -
*
* s3:PutObject
*
*
* -
*
* s3:GetBucketLocation
*
*
* -
*
* s3:ListAllMyBuckets
*
*
* -
*
* cloudwatch:PutMetricData
*
*
* -
*
* logs:CreateLogGroup
*
*
* -
*
* logs:CreateLogStream
*
*
* -
*
* logs:CreateLogStream
*
*
*/
public String getExecutionRoleArn() {
return this.executionRoleArn;
}
/**
*
* The ARN of the IAM role to be used to run the canary. This role must already exist, and must include
* lambda.amazonaws.com as a principal in the trust policy. The role must also have the following
* permissions:
*
*
* -
*
* s3:PutObject
*
*
* -
*
* s3:GetBucketLocation
*
*
* -
*
* s3:ListAllMyBuckets
*
*
* -
*
* cloudwatch:PutMetricData
*
*
* -
*
* logs:CreateLogGroup
*
*
* -
*
* logs:CreateLogStream
*
*
* -
*
* logs:CreateLogStream
*
*
*
*
* @param executionRoleArn
* The ARN of the IAM role to be used to run the canary. This role must already exist, and must include
* lambda.amazonaws.com as a principal in the trust policy. The role must also have the
* following permissions:
*
* -
*
* s3:PutObject
*
*
* -
*
* s3:GetBucketLocation
*
*
* -
*
* s3:ListAllMyBuckets
*
*
* -
*
* cloudwatch:PutMetricData
*
*
* -
*
* logs:CreateLogGroup
*
*
* -
*
* logs:CreateLogStream
*
*
* -
*
* logs:CreateLogStream
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateCanaryRequest withExecutionRoleArn(String executionRoleArn) {
setExecutionRoleArn(executionRoleArn);
return this;
}
/**
*
* Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For
* more information about runtime versions, see
* Canary Runtime Versions.
*
*
* @param runtimeVersion
* Specifies the runtime version to use for the canary. Currently, the only valid value is
* syn-1.0. For more information about runtime versions, see Canary Runtime Versions.
*/
public void setRuntimeVersion(String runtimeVersion) {
this.runtimeVersion = runtimeVersion;
}
/**
*
* Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For
* more information about runtime versions, see
* Canary Runtime Versions.
*
*
* @return Specifies the runtime version to use for the canary. Currently, the only valid value is
* syn-1.0. For more information about runtime versions, see Canary Runtime Versions.
*/
public String getRuntimeVersion() {
return this.runtimeVersion;
}
/**
*
* Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For
* more information about runtime versions, see
* Canary Runtime Versions.
*
*
* @param runtimeVersion
* Specifies the runtime version to use for the canary. Currently, the only valid value is
* syn-1.0. For more information about runtime versions, see Canary Runtime Versions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateCanaryRequest withRuntimeVersion(String runtimeVersion) {
setRuntimeVersion(runtimeVersion);
return this;
}
/**
*
* A structure that contains information about how often the canary is to run, and when these runs are to stop.
*
*
* @param schedule
* A structure that contains information about how often the canary is to run, and when these runs are to
* stop.
*/
public void setSchedule(CanaryScheduleInput schedule) {
this.schedule = schedule;
}
/**
*
* A structure that contains information about how often the canary is to run, and when these runs are to stop.
*
*
* @return A structure that contains information about how often the canary is to run, and when these runs are to
* stop.
*/
public CanaryScheduleInput getSchedule() {
return this.schedule;
}
/**
*
* A structure that contains information about how often the canary is to run, and when these runs are to stop.
*
*
* @param schedule
* A structure that contains information about how often the canary is to run, and when these runs are to
* stop.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateCanaryRequest withSchedule(CanaryScheduleInput schedule) {
setSchedule(schedule);
return this;
}
/**
*
* A structure that contains the timeout value that is used for each individual run of the canary.
*
*
* @param runConfig
* A structure that contains the timeout value that is used for each individual run of the canary.
*/
public void setRunConfig(CanaryRunConfigInput runConfig) {
this.runConfig = runConfig;
}
/**
*
* A structure that contains the timeout value that is used for each individual run of the canary.
*
*
* @return A structure that contains the timeout value that is used for each individual run of the canary.
*/
public CanaryRunConfigInput getRunConfig() {
return this.runConfig;
}
/**
*
* A structure that contains the timeout value that is used for each individual run of the canary.
*
*
* @param runConfig
* A structure that contains the timeout value that is used for each individual run of the canary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateCanaryRequest withRunConfig(CanaryRunConfigInput runConfig) {
setRunConfig(runConfig);
return this;
}
/**
*
* The number of days to retain data about successful runs of this canary.
*
*
* @param successRetentionPeriodInDays
* The number of days to retain data about successful runs of this canary.
*/
public void setSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays) {
this.successRetentionPeriodInDays = successRetentionPeriodInDays;
}
/**
*
* The number of days to retain data about successful runs of this canary.
*
*
* @return The number of days to retain data about successful runs of this canary.
*/
public Integer getSuccessRetentionPeriodInDays() {
return this.successRetentionPeriodInDays;
}
/**
*
* The number of days to retain data about successful runs of this canary.
*
*
* @param successRetentionPeriodInDays
* The number of days to retain data about successful runs of this canary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateCanaryRequest withSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays) {
setSuccessRetentionPeriodInDays(successRetentionPeriodInDays);
return this;
}
/**
*
* The number of days to retain data about failed runs of this canary.
*
*
* @param failureRetentionPeriodInDays
* The number of days to retain data about failed runs of this canary.
*/
public void setFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays) {
this.failureRetentionPeriodInDays = failureRetentionPeriodInDays;
}
/**
*
* The number of days to retain data about failed runs of this canary.
*
*
* @return The number of days to retain data about failed runs of this canary.
*/
public Integer getFailureRetentionPeriodInDays() {
return this.failureRetentionPeriodInDays;
}
/**
*
* The number of days to retain data about failed runs of this canary.
*
*
* @param failureRetentionPeriodInDays
* The number of days to retain data about failed runs of this canary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateCanaryRequest withFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays) {
setFailureRetentionPeriodInDays(failureRetentionPeriodInDays);
return this;
}
/**
*
* If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security
* groups of the VPC endpoint. For more information, see
* Running a Canary in a VPC.
*
*
* @param vpcConfig
* If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and
* security groups of the VPC endpoint. For more information, see
* Running a Canary in a VPC.
*/
public void setVpcConfig(VpcConfigInput vpcConfig) {
this.vpcConfig = vpcConfig;
}
/**
*
* If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security
* groups of the VPC endpoint. For more information, see
* Running a Canary in a VPC.
*
*
* @return If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and
* security groups of the VPC endpoint. For more information, see
* Running a Canary in a VPC.
*/
public VpcConfigInput getVpcConfig() {
return this.vpcConfig;
}
/**
*
* If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security
* groups of the VPC endpoint. For more information, see
* Running a Canary in a VPC.
*
*
* @param vpcConfig
* If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and
* security groups of the VPC endpoint. For more information, see
* Running a Canary in a VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateCanaryRequest withVpcConfig(VpcConfigInput vpcConfig) {
setVpcConfig(vpcConfig);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getCode() != null)
sb.append("Code: ").append(getCode()).append(",");
if (getExecutionRoleArn() != null)
sb.append("ExecutionRoleArn: ").append(getExecutionRoleArn()).append(",");
if (getRuntimeVersion() != null)
sb.append("RuntimeVersion: ").append(getRuntimeVersion()).append(",");
if (getSchedule() != null)
sb.append("Schedule: ").append(getSchedule()).append(",");
if (getRunConfig() != null)
sb.append("RunConfig: ").append(getRunConfig()).append(",");
if (getSuccessRetentionPeriodInDays() != null)
sb.append("SuccessRetentionPeriodInDays: ").append(getSuccessRetentionPeriodInDays()).append(",");
if (getFailureRetentionPeriodInDays() != null)
sb.append("FailureRetentionPeriodInDays: ").append(getFailureRetentionPeriodInDays()).append(",");
if (getVpcConfig() != null)
sb.append("VpcConfig: ").append(getVpcConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateCanaryRequest == false)
return false;
UpdateCanaryRequest other = (UpdateCanaryRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getCode() == null ^ this.getCode() == null)
return false;
if (other.getCode() != null && other.getCode().equals(this.getCode()) == false)
return false;
if (other.getExecutionRoleArn() == null ^ this.getExecutionRoleArn() == null)
return false;
if (other.getExecutionRoleArn() != null && other.getExecutionRoleArn().equals(this.getExecutionRoleArn()) == false)
return false;
if (other.getRuntimeVersion() == null ^ this.getRuntimeVersion() == null)
return false;
if (other.getRuntimeVersion() != null && other.getRuntimeVersion().equals(this.getRuntimeVersion()) == false)
return false;
if (other.getSchedule() == null ^ this.getSchedule() == null)
return false;
if (other.getSchedule() != null && other.getSchedule().equals(this.getSchedule()) == false)
return false;
if (other.getRunConfig() == null ^ this.getRunConfig() == null)
return false;
if (other.getRunConfig() != null && other.getRunConfig().equals(this.getRunConfig()) == false)
return false;
if (other.getSuccessRetentionPeriodInDays() == null ^ this.getSuccessRetentionPeriodInDays() == null)
return false;
if (other.getSuccessRetentionPeriodInDays() != null && other.getSuccessRetentionPeriodInDays().equals(this.getSuccessRetentionPeriodInDays()) == false)
return false;
if (other.getFailureRetentionPeriodInDays() == null ^ this.getFailureRetentionPeriodInDays() == null)
return false;
if (other.getFailureRetentionPeriodInDays() != null && other.getFailureRetentionPeriodInDays().equals(this.getFailureRetentionPeriodInDays()) == false)
return false;
if (other.getVpcConfig() == null ^ this.getVpcConfig() == null)
return false;
if (other.getVpcConfig() != null && other.getVpcConfig().equals(this.getVpcConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getCode() == null) ? 0 : getCode().hashCode());
hashCode = prime * hashCode + ((getExecutionRoleArn() == null) ? 0 : getExecutionRoleArn().hashCode());
hashCode = prime * hashCode + ((getRuntimeVersion() == null) ? 0 : getRuntimeVersion().hashCode());
hashCode = prime * hashCode + ((getSchedule() == null) ? 0 : getSchedule().hashCode());
hashCode = prime * hashCode + ((getRunConfig() == null) ? 0 : getRunConfig().hashCode());
hashCode = prime * hashCode + ((getSuccessRetentionPeriodInDays() == null) ? 0 : getSuccessRetentionPeriodInDays().hashCode());
hashCode = prime * hashCode + ((getFailureRetentionPeriodInDays() == null) ? 0 : getFailureRetentionPeriodInDays().hashCode());
hashCode = prime * hashCode + ((getVpcConfig() == null) ? 0 : getVpcConfig().hashCode());
return hashCode;
}
@Override
public UpdateCanaryRequest clone() {
return (UpdateCanaryRequest) super.clone();
}
}