public class AbstractAmazonConfig extends Object implements AmazonConfig
AmazonConfig. Convenient method forms pass
through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException.| Modifier and Type | Method and Description |
|---|---|
void |
deleteConfigRule(DeleteConfigRuleRequest request)
Deletes the specified AWS Config rule and all of its evaluation results.
|
void |
deleteDeliveryChannel(DeleteDeliveryChannelRequest request)
Deletes the specified delivery channel.
|
DeliverConfigSnapshotResult |
deliverConfigSnapshot(DeliverConfigSnapshotRequest request)
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in
the specified delivery channel.
|
DescribeComplianceByConfigRuleResult |
describeComplianceByConfigRule()
Simplified method form for invoking the DescribeComplianceByConfigRule
operation.
|
DescribeComplianceByConfigRuleResult |
describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest request)
Indicates whether the specified AWS Config rules are compliant.
|
DescribeComplianceByResourceResult |
describeComplianceByResource()
Simplified method form for invoking the DescribeComplianceByResource
operation.
|
DescribeComplianceByResourceResult |
describeComplianceByResource(DescribeComplianceByResourceRequest request)
Indicates whether the specified AWS resources are compliant.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus()
Simplified method form for invoking the
DescribeConfigRuleEvaluationStatus operation.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest request)
Returns status information for each of your AWS managed Config rules.
|
DescribeConfigRulesResult |
describeConfigRules()
Simplified method form for invoking the DescribeConfigRules operation.
|
DescribeConfigRulesResult |
describeConfigRules(DescribeConfigRulesRequest request)
Returns details about your AWS Config rules.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders()
Simplified method form for invoking the DescribeConfigurationRecorders
operation.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders(DescribeConfigurationRecordersRequest request)
Returns the name of one or more specified configuration recorders.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus()
Simplified method form for invoking the
DescribeConfigurationRecorderStatus operation.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest request)
Returns the current status of the specified configuration recorder.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels()
Simplified method form for invoking the DescribeDeliveryChannels
operation.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels(DescribeDeliveryChannelsRequest request)
Returns details about the specified delivery channel.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus()
Simplified method form for invoking the DescribeDeliveryChannelStatus
operation.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest request)
Returns the current status of the specified delivery channel.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
GetComplianceDetailsByConfigRuleResult |
getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest request)
Returns the evaluation results for the specified AWS Config rule.
|
GetComplianceDetailsByResourceResult |
getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest request)
Returns the evaluation results for the specified AWS resource.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule()
Simplified method form for invoking the GetComplianceSummaryByConfigRule
operation.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest request)
Returns the number of AWS Config rules that are compliant and
noncompliant, up to a maximum of 25 for each.
|
GetComplianceSummaryByResourceTypeResult |
getComplianceSummaryByResourceType()
Simplified method form for invoking the
GetComplianceSummaryByResourceType operation.
|
GetComplianceSummaryByResourceTypeResult |
getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest request)
Returns the number of resources that are compliant and the number that
are noncompliant.
|
GetResourceConfigHistoryResult |
getResourceConfigHistory(GetResourceConfigHistoryRequest request)
Returns a list of configuration items for the specified resource.
|
ListDiscoveredResourcesResult |
listDiscoveredResources(ListDiscoveredResourcesRequest request)
Accepts a resource type and returns a list of resource identifiers for
the resources of that type.
|
void |
putConfigRule(PutConfigRuleRequest request)
Adds or updates an AWS Config rule for evaluating whether your AWS
resources comply with your desired configurations.
|
void |
putConfigurationRecorder(PutConfigurationRecorderRequest request)
Creates a new configuration recorder to record the selected resource
configurations.
|
void |
putDeliveryChannel(PutDeliveryChannelRequest request)
Creates a new delivery channel object to deliver the configuration
information to an Amazon S3 bucket, and to an Amazon SNS topic.
|
PutEvaluationsResult |
putEvaluations(PutEvaluationsRequest request)
Used by an AWS Lambda function to deliver evaluation results to AWS
Config.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("config.us-east-1.amazonaws.com/").
|
void |
setRegion(Region region)
An alternative to
AmazonConfig.setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void |
startConfigurationRecorder(StartConfigurationRecorderRequest request)
Starts recording configurations of the AWS resources you have selected to
record in your AWS account.
|
void |
stopConfigurationRecorder(StopConfigurationRecorderRequest request)
Stops recording configurations of the AWS resources you have selected to
record in your AWS account.
|
public void setEndpoint(String endpoint)
AmazonConfig
Callers can pass in just the endpoint (ex:
"config.us-east-1.amazonaws.com/") or a full URL, including the protocol
(ex: "config.us-east-1.amazonaws.com/"). If the protocol is not specified
here, the default protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonConfigendpoint - The endpoint (ex: "config.us-east-1.amazonaws.com/") or a full
URL, including the protocol (ex:
"config.us-east-1.amazonaws.com/") of the region specific AWS
endpoint this client will communicate with.public void setRegion(Region region)
AmazonConfigAmazonConfig.setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonConfigregion - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public void deleteConfigRule(DeleteConfigRuleRequest request)
AmazonConfigDeletes the specified AWS Config rule and all of its evaluation results.
AWS Config sets the state of a rule to DELETING until the
deletion is complete. You cannot update a rule while it is in this state.
If you make a PutConfigRule request for the rule, you will
receive a ResourceInUseException.
You can check the state of a rule by using the
DescribeConfigRules request.
deleteConfigRule in interface AmazonConfigpublic void deleteDeliveryChannel(DeleteDeliveryChannelRequest request)
AmazonConfigDeletes the specified delivery channel.
The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the StopConfigurationRecorder action.
deleteDeliveryChannel in interface AmazonConfigrequest - The input for the DeleteDeliveryChannel action. The action
accepts the following data in JSON format.public DeliverConfigSnapshotResult deliverConfigSnapshot(DeliverConfigSnapshotRequest request)
AmazonConfigSchedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.
deliverConfigSnapshot in interface AmazonConfigrequest - The input for the DeliverConfigSnapshot action.public DescribeComplianceByConfigRuleResult describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest request)
AmazonConfigIndicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply.
If AWS Config has no current evaluation results for the rule, it returns
InsufficientData. This result might indicate one of the
following conditions:
DescribeConfigRuleEvaluationStatus
action to get the LastSuccessfulInvocationTime and
LastFailedInvocationTime.config:PutEvaluations
permission. If the rule is a customer managed rule, verify that the AWS
Lambda execution role includes the config:PutEvaluations
permission.NOT_APPLICABLE for all evaluation results. This can occur if
the resources were deleted or removed from the rule's scope.describeComplianceByConfigRule in interface AmazonConfigpublic DescribeComplianceByConfigRuleResult describeComplianceByConfigRule()
AmazonConfigdescribeComplianceByConfigRule in interface AmazonConfigAmazonConfig.describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest)public DescribeComplianceByResourceResult describeComplianceByResource(DescribeComplianceByResourceRequest request)
AmazonConfigIndicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with.
A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If AWS Config has no current evaluation results for the resource, it
returns InsufficientData. This result might indicate one of
the following conditions about the rules that evaluate the resource:
DescribeConfigRuleEvaluationStatus
action to get the LastSuccessfulInvocationTime and
LastFailedInvocationTime.config:PutEvaluations
permission. If the rule is a customer managed rule, verify that the AWS
Lambda execution role includes the config:PutEvaluations
permission.NOT_APPLICABLE for all evaluation results. This can occur if
the resources were deleted or removed from the rule's scope.describeComplianceByResource in interface AmazonConfigpublic DescribeComplianceByResourceResult describeComplianceByResource()
AmazonConfigdescribeComplianceByResource in interface AmazonConfigAmazonConfig.describeComplianceByResource(DescribeComplianceByResourceRequest)public DescribeConfigRuleEvaluationStatusResult describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest request)
AmazonConfigReturns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.
describeConfigRuleEvaluationStatus in interface AmazonConfigpublic DescribeConfigRuleEvaluationStatusResult describeConfigRuleEvaluationStatus()
AmazonConfigdescribeConfigRuleEvaluationStatus in interface AmazonConfigAmazonConfig.describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest)public DescribeConfigRulesResult describeConfigRules(DescribeConfigRulesRequest request)
AmazonConfigReturns details about your AWS Config rules.
describeConfigRules in interface AmazonConfigpublic DescribeConfigRulesResult describeConfigRules()
AmazonConfigdescribeConfigRules in interface AmazonConfigAmazonConfig.describeConfigRules(DescribeConfigRulesRequest)public DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest request)
AmazonConfigReturns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.
describeConfigurationRecorderStatus in interface AmazonConfigrequest - The input for the DescribeConfigurationRecorderStatus
action.public DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus()
AmazonConfigdescribeConfigurationRecorderStatus in interface AmazonConfigAmazonConfig.describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest)public DescribeConfigurationRecordersResult describeConfigurationRecorders(DescribeConfigurationRecordersRequest request)
AmazonConfigReturns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.
Currently, you can specify only one configuration recorder per account.
describeConfigurationRecorders in interface AmazonConfigrequest - The input for the DescribeConfigurationRecorders action.public DescribeConfigurationRecordersResult describeConfigurationRecorders()
AmazonConfigdescribeConfigurationRecorders in interface AmazonConfigAmazonConfig.describeConfigurationRecorders(DescribeConfigurationRecordersRequest)public DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest request)
AmazonConfigReturns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
describeDeliveryChannelStatus in interface AmazonConfigrequest - The input for the DeliveryChannelStatus action.public DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus()
AmazonConfigdescribeDeliveryChannelStatus in interface AmazonConfigAmazonConfig.describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest)public DescribeDeliveryChannelsResult describeDeliveryChannels(DescribeDeliveryChannelsRequest request)
AmazonConfigReturns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
Currently, you can specify only one delivery channel per account.
describeDeliveryChannels in interface AmazonConfigrequest - The input for the DescribeDeliveryChannels action.public DescribeDeliveryChannelsResult describeDeliveryChannels()
AmazonConfigdescribeDeliveryChannels in interface AmazonConfigAmazonConfig.describeDeliveryChannels(DescribeDeliveryChannelsRequest)public GetComplianceDetailsByConfigRuleResult getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest request)
AmazonConfigReturns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
getComplianceDetailsByConfigRule in interface AmazonConfigpublic GetComplianceDetailsByResourceResult getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest request)
AmazonConfigReturns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.
getComplianceDetailsByResource in interface AmazonConfigpublic GetComplianceSummaryByConfigRuleResult getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest request)
AmazonConfigReturns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
getComplianceSummaryByConfigRule in interface AmazonConfigpublic GetComplianceSummaryByConfigRuleResult getComplianceSummaryByConfigRule()
AmazonConfiggetComplianceSummaryByConfigRule in interface AmazonConfigAmazonConfig.getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest)public GetComplianceSummaryByResourceTypeResult getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest request)
AmazonConfigReturns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.
getComplianceSummaryByResourceType in interface AmazonConfigpublic GetComplianceSummaryByResourceTypeResult getComplianceSummaryByResourceType()
AmazonConfiggetComplianceSummaryByResourceType in interface AmazonConfigAmazonConfig.getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest)public GetResourceConfigHistoryResult getResourceConfigHistory(GetResourceConfigHistoryRequest request)
AmazonConfigReturns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval.
The response is paginated, and by default, AWS Config returns a limit of
10 configuration items per page. You can customize this number with the
limit parameter. The response includes a
nextToken string, and to get the next page of results, run
the request again and enter this string for the nextToken
parameter.
Each call to the API is limited to span a duration of seven days. It is
likely that the number of records returned is smaller than the specified
limit. In such cases, you can make another call, using the
nextToken.
getResourceConfigHistory in interface AmazonConfigrequest - The input for the GetResourceConfigHistory action.public ListDiscoveredResourcesResult listDiscoveredResources(ListDiscoveredResourcesRequest request)
AmazonConfigAccepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
The response is paginated, and by default AWS Config lists 100 resource
identifiers on each page. You can customize this number with the
limit parameter. The response includes a
nextToken string, and to get the next page of results, run
the request again and enter this string for the nextToken
parameter.
listDiscoveredResources in interface AmazonConfigpublic void putConfigRule(PutConfigRuleRequest request)
AmazonConfigAdds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
You can use this action for customer managed Config rules and AWS managed Config rules. A customer managed Config rule is a custom rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that is provided by AWS Config.
If you are adding a new customer managed Config rule, you must first
create the AWS Lambda function that the rule invokes to evaluate your
resources. When you use the PutConfigRule action to add the
rule to AWS Config, you must specify the Amazon Resource Name (ARN) that
AWS Lambda assigns to the function. Specify the ARN for the
SourceIdentifier key. This key is part of the
Source object, which is part of the ConfigRule
object.
If you are adding a new AWS managed Config rule, specify the rule's
identifier for the SourceIdentifier key. To reference AWS
managed Config rule identifiers, see Using AWS Managed Config Rules.
For any new rule that you add, specify the ConfigRuleName in
the ConfigRule object. Do not specify the
ConfigRuleArn or the ConfigRuleId. These values
are generated by AWS Config for new rules.
If you are updating a rule that you have added previously, specify the
rule's ConfigRuleName, ConfigRuleId, or
ConfigRuleArn in the ConfigRule data type that
you use in this request.
The maximum number of rules that AWS Config supports is 25.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
putConfigRule in interface AmazonConfigpublic void putConfigurationRecorder(PutConfigurationRecorderRequest request)
AmazonConfigCreates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN and/or
the recordingGroup of an existing recorder. To change the
role, call the action on the existing configuration recorder and specify
a role.
Currently, you can specify only one configuration recorder per account.
If ConfigurationRecorder does not have the
recordingGroup parameter specified, the default is to record all
supported resource types.
putConfigurationRecorder in interface AmazonConfigrequest - The input for the PutConfigurationRecorder action.public void putDeliveryChannel(PutDeliveryChannelRequest request)
AmazonConfigCreates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
Currently, you can specify only one delivery channel per account.
putDeliveryChannel in interface AmazonConfigrequest - The input for the PutDeliveryChannel action.public PutEvaluationsResult putEvaluations(PutEvaluationsRequest request)
AmazonConfigUsed by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.
putEvaluations in interface AmazonConfigpublic void startConfigurationRecorder(StartConfigurationRecorderRequest request)
AmazonConfigStarts recording configurations of the AWS resources you have selected to record in your AWS account.
You must have created at least one delivery channel to successfully start the configuration recorder.
startConfigurationRecorder in interface AmazonConfigrequest - The input for the StartConfigurationRecorder action.public void stopConfigurationRecorder(StopConfigurationRecorderRequest request)
AmazonConfigStops recording configurations of the AWS resources you have selected to record in your AWS account.
stopConfigurationRecorder in interface AmazonConfigrequest - The input for the StopConfigurationRecorder action.
public void shutdown()
AmazonConfigshutdown in interface AmazonConfigpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonConfigResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonConfigrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.