Class AbstractAmazonConfig

  • All Implemented Interfaces:
    AmazonConfig
    Direct Known Subclasses:
    AbstractAmazonConfigAsync

    public class AbstractAmazonConfig
    extends Object
    implements AmazonConfig
    Abstract implementation of AmazonConfig. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.
    • Constructor Detail

      • AbstractAmazonConfig

        protected AbstractAmazonConfig()
    • Method Detail

      • setEndpoint

        public void setEndpoint​(String endpoint)
        Description copied from interface: AmazonConfig
        Overrides the default endpoint for this client ("config.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

        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.

        Specified by:
        setEndpoint in interface AmazonConfig
        Parameters:
        endpoint - 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.
      • deleteConfigRule

        public DeleteConfigRuleResult deleteConfigRule​(DeleteConfigRuleRequest request)
        Description copied from interface: AmazonConfig

        Deletes 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 or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

        You can check the state of a rule by using the DescribeConfigRules request.

        Specified by:
        deleteConfigRule in interface AmazonConfig
        Returns:
        Result of the DeleteConfigRule operation returned by the service.
      • deliverConfigSnapshot

        public DeliverConfigSnapshotResult deliverConfigSnapshot​(DeliverConfigSnapshotRequest request)
        Description copied from interface: AmazonConfig

        Schedules 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.

        • Notification of starting the delivery.
        • Notification of delivery completed, if the delivery was successfully completed.
        • Notification of delivery failure, if the delivery failed to complete.
        Specified by:
        deliverConfigSnapshot in interface AmazonConfig
        Parameters:
        request - The input for the DeliverConfigSnapshot action.
        Returns:
        Result of the DeliverConfigSnapshot operation returned by the service.
      • describeComplianceByConfigRule

        public DescribeComplianceByConfigRuleResult describeComplianceByConfigRule​(DescribeComplianceByConfigRuleRequest request)
        Description copied from interface: AmazonConfig

        Indicates 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 INSUFFICIENT_DATA. This result might indicate one of the following conditions:

        • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.
        • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.
        • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

        Specified by:
        describeComplianceByConfigRule in interface AmazonConfig
        Returns:
        Result of the DescribeComplianceByConfigRule operation returned by the service.
      • describeComplianceByResource

        public DescribeComplianceByResourceResult describeComplianceByResource​(DescribeComplianceByResourceRequest request)
        Description copied from interface: AmazonConfig

        Indicates 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 INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

        • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.
        • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.
        • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

        Specified by:
        describeComplianceByResource in interface AmazonConfig
        Returns:
        Result of the DescribeComplianceByResource operation returned by the service.
      • getResourceConfigHistory

        public GetResourceConfigHistoryResult getResourceConfigHistory​(GetResourceConfigHistoryRequest request)
        Description copied from interface: AmazonConfig

        Returns 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.

        Specified by:
        getResourceConfigHistory in interface AmazonConfig
        Parameters:
        request - The input for the GetResourceConfigHistory action.
        Returns:
        Result of the GetResourceConfigHistory operation returned by the service.
      • listDiscoveredResources

        public ListDiscoveredResourcesResult listDiscoveredResources​(ListDiscoveredResourcesRequest request)
        Description copied from interface: AmazonConfig

        Accepts 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.

        You can specify either resource IDs or a resource name but not both in the same request.

        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.

        Specified by:
        listDiscoveredResources in interface AmazonConfig
        Returns:
        Result of the ListDiscoveredResources operation returned by the service.
      • putConfigRule

        public PutConfigRuleResult putConfigRule​(PutConfigRuleRequest request)
        Description copied from interface: AmazonConfig

        Adds 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.

        Specified by:
        putConfigRule in interface AmazonConfig
        Returns:
        Result of the PutConfigRule operation returned by the service.
      • putConfigurationRecorder

        public PutConfigurationRecorderResult putConfigurationRecorder​(PutConfigurationRecorderRequest request)
        Description copied from interface: AmazonConfig

        Creates 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.

        Specified by:
        putConfigurationRecorder in interface AmazonConfig
        Parameters:
        request - The input for the PutConfigurationRecorder action.
        Returns:
        Result of the PutConfigurationRecorder operation returned by the service.
      • putDeliveryChannel

        public PutDeliveryChannelResult putDeliveryChannel​(PutDeliveryChannelRequest request)
        Description copied from interface: AmazonConfig

        Creates 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.

        Specified by:
        putDeliveryChannel in interface AmazonConfig
        Parameters:
        request - The input for the PutDeliveryChannel action.
        Returns:
        Result of the PutDeliveryChannel operation returned by the service.
      • putEvaluations

        public PutEvaluationsResult putEvaluations​(PutEvaluationsRequest request)
        Description copied from interface: AmazonConfig

        Used 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.

        Specified by:
        putEvaluations in interface AmazonConfig
        Returns:
        Result of the PutEvaluations operation returned by the service.
      • shutdown

        public void shutdown()
        Description copied from interface: AmazonConfig
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
        Specified by:
        shutdown in interface AmazonConfig
      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        Description copied from interface: AmazonConfig
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response 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.

        Specified by:
        getCachedResponseMetadata in interface AmazonConfig
        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.