BaseConfigurationItem (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.config.model.BaseConfigurationItem

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BaseConfigurationItem
extends Object
implements Serializable, Cloneable, StructuredPojo

The detailed configuration of a specified resource.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BaseConfigurationItem()

Constructors
Constructor and Description
`BaseConfigurationItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BaseConfigurationItem`	`addSupplementaryConfigurationEntry(String key, String value)` Add a single SupplementaryConfiguration entry
`BaseConfigurationItem`	`clearSupplementaryConfigurationEntries()` Removes all the entries added into SupplementaryConfiguration.
`BaseConfigurationItem`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountId()` The 12-digit Amazon Web Services account ID associated with the resource.
`String`	`getArn()` The Amazon Resource Name (ARN) of the resource.
`String`	`getAvailabilityZone()` The Availability Zone associated with the resource.
`String`	`getAwsRegion()` The region where the resource resides.
`String`	`getConfiguration()` The description of the resource configuration.
`Date`	`getConfigurationItemCaptureTime()` The time when the configuration recording was initiated.
`String`	`getConfigurationItemStatus()` The configuration item status.
`String`	`getConfigurationStateId()` An identifier that indicates the ordering of the configuration items of a resource.
`Date`	`getResourceCreationTime()` The time stamp when the resource was created.
`String`	`getResourceId()` The ID of the resource (for example., sg-xxxxxx).
`String`	`getResourceName()` The custom name of the resource, if available.
`String`	`getResourceType()` The type of Amazon Web Services resource.
`Map<String,String>`	`getSupplementaryConfiguration()` Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
`String`	`getVersion()` The version number of the resource configuration.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccountId(String accountId)` The 12-digit Amazon Web Services account ID associated with the resource.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the resource.
`void`	`setAvailabilityZone(String availabilityZone)` The Availability Zone associated with the resource.
`void`	`setAwsRegion(String awsRegion)` The region where the resource resides.
`void`	`setConfiguration(String configuration)` The description of the resource configuration.
`void`	`setConfigurationItemCaptureTime(Date configurationItemCaptureTime)` The time when the configuration recording was initiated.
`void`	`setConfigurationItemStatus(String configurationItemStatus)` The configuration item status.
`void`	`setConfigurationStateId(String configurationStateId)` An identifier that indicates the ordering of the configuration items of a resource.
`void`	`setResourceCreationTime(Date resourceCreationTime)` The time stamp when the resource was created.
`void`	`setResourceId(String resourceId)` The ID of the resource (for example., sg-xxxxxx).
`void`	`setResourceName(String resourceName)` The custom name of the resource, if available.
`void`	`setResourceType(String resourceType)` The type of Amazon Web Services resource.
`void`	`setSupplementaryConfiguration(Map<String,String> supplementaryConfiguration)` Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
`void`	`setVersion(String version)` The version number of the resource configuration.
`String`	`toString()` Returns a string representation of this object.
`BaseConfigurationItem`	`withAccountId(String accountId)` The 12-digit Amazon Web Services account ID associated with the resource.
`BaseConfigurationItem`	`withArn(String arn)` The Amazon Resource Name (ARN) of the resource.
`BaseConfigurationItem`	`withAvailabilityZone(String availabilityZone)` The Availability Zone associated with the resource.
`BaseConfigurationItem`	`withAwsRegion(String awsRegion)` The region where the resource resides.
`BaseConfigurationItem`	`withConfiguration(String configuration)` The description of the resource configuration.
`BaseConfigurationItem`	`withConfigurationItemCaptureTime(Date configurationItemCaptureTime)` The time when the configuration recording was initiated.
`BaseConfigurationItem`	`withConfigurationItemStatus(ConfigurationItemStatus configurationItemStatus)` The configuration item status.
`BaseConfigurationItem`	`withConfigurationItemStatus(String configurationItemStatus)` The configuration item status.
`BaseConfigurationItem`	`withConfigurationStateId(String configurationStateId)` An identifier that indicates the ordering of the configuration items of a resource.
`BaseConfigurationItem`	`withResourceCreationTime(Date resourceCreationTime)` The time stamp when the resource was created.
`BaseConfigurationItem`	`withResourceId(String resourceId)` The ID of the resource (for example., sg-xxxxxx).
`BaseConfigurationItem`	`withResourceName(String resourceName)` The custom name of the resource, if available.
`BaseConfigurationItem`	`withResourceType(ResourceType resourceType)` The type of Amazon Web Services resource.
`BaseConfigurationItem`	`withResourceType(String resourceType)` The type of Amazon Web Services resource.
`BaseConfigurationItem`	`withSupplementaryConfiguration(Map<String,String> supplementaryConfiguration)` Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
`BaseConfigurationItem`	`withVersion(String version)` The version number of the resource configuration.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BaseConfigurationItem
```
public BaseConfigurationItem()
```
- Method Detail
  - setVersion
```
public void setVersion(String version)
```
    The version number of the resource configuration.
    
    Parameters:
    
    version - The version number of the resource configuration.
  - getVersion
```
public String getVersion()
```
    The version number of the resource configuration.
    
    Returns:
    
    The version number of the resource configuration.
  - withVersion
```
public BaseConfigurationItem withVersion(String version)
```
    The version number of the resource configuration.
    
    Parameters:
    
    version - The version number of the resource configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccountId
```
public void setAccountId(String accountId)
```
    The 12-digit Amazon Web Services account ID associated with the resource.
    
    Parameters:
    
    accountId - The 12-digit Amazon Web Services account ID associated with the resource.
  - getAccountId
```
public String getAccountId()
```
    The 12-digit Amazon Web Services account ID associated with the resource.
    
    Returns:
    
    The 12-digit Amazon Web Services account ID associated with the resource.
  - withAccountId
```
public BaseConfigurationItem withAccountId(String accountId)
```
    The 12-digit Amazon Web Services account ID associated with the resource.
    
    Parameters:
    
    accountId - The 12-digit Amazon Web Services account ID associated with the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfigurationItemCaptureTime
```
public void setConfigurationItemCaptureTime(Date configurationItemCaptureTime)
```
    The time when the configuration recording was initiated.
    
    Parameters:
    
    configurationItemCaptureTime - The time when the configuration recording was initiated.
  - getConfigurationItemCaptureTime
```
public Date getConfigurationItemCaptureTime()
```
    The time when the configuration recording was initiated.
    
    Returns:
    
    The time when the configuration recording was initiated.
  - withConfigurationItemCaptureTime
```
public BaseConfigurationItem withConfigurationItemCaptureTime(Date configurationItemCaptureTime)
```
    The time when the configuration recording was initiated.
    
    Parameters:
    
    configurationItemCaptureTime - The time when the configuration recording was initiated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfigurationItemStatus
```
public void setConfigurationItemStatus(String configurationItemStatus)
```
    The configuration item status. The valid values are:
    - OK – The resource configuration has been updated
    - ResourceDiscovered – The resource was newly discovered
    - ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
    - ResourceDeleted – The resource was deleted
    - ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
    The CIs do not incur any cost.
    Parameters:
    configurationItemStatus - The configuration item status. The valid values are:
    
    OK – The resource configuration has been updated
    
    ResourceDiscovered – The resource was newly discovered
    
    ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
    
    ResourceDeleted – The resource was deleted
    
    ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
    
    The CIs do not incur any cost.
    See Also:
    
    ConfigurationItemStatus
  - getConfigurationItemStatus
```
public String getConfigurationItemStatus()
```
    The configuration item status. The valid values are:
    - OK – The resource configuration has been updated
    - ResourceDiscovered – The resource was newly discovered
    - ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
    - ResourceDeleted – The resource was deleted
    - ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
    The CIs do not incur any cost.
    Returns:
    The configuration item status. The valid values are:
    
    OK – The resource configuration has been updated
    
    ResourceDiscovered – The resource was newly discovered
    
    ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
    
    ResourceDeleted – The resource was deleted
    
    ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
    
    The CIs do not incur any cost.
    See Also:
    
    ConfigurationItemStatus
  - withConfigurationItemStatus
```
public BaseConfigurationItem withConfigurationItemStatus(String configurationItemStatus)
```
    The configuration item status. The valid values are:
    - OK – The resource configuration has been updated
    - ResourceDiscovered – The resource was newly discovered
    - ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
    - ResourceDeleted – The resource was deleted
    - ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
    The CIs do not incur any cost.
    Parameters:
    configurationItemStatus - The configuration item status. The valid values are:
    
    OK – The resource configuration has been updated
    
    ResourceDiscovered – The resource was newly discovered
    
    ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
    
    ResourceDeleted – The resource was deleted
    
    ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
    
    The CIs do not incur any cost.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfigurationItemStatus
  - withConfigurationItemStatus
```
public BaseConfigurationItem withConfigurationItemStatus(ConfigurationItemStatus configurationItemStatus)
```
    The configuration item status. The valid values are:
    - OK – The resource configuration has been updated
    - ResourceDiscovered – The resource was newly discovered
    - ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
    - ResourceDeleted – The resource was deleted
    - ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
    The CIs do not incur any cost.
    Parameters:
    configurationItemStatus - The configuration item status. The valid values are:
    
    OK – The resource configuration has been updated
    
    ResourceDiscovered – The resource was newly discovered
    
    ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
    
    ResourceDeleted – The resource was deleted
    
    ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
    
    The CIs do not incur any cost.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfigurationItemStatus
  - setConfigurationStateId
```
public void setConfigurationStateId(String configurationStateId)
```
    An identifier that indicates the ordering of the configuration items of a resource.
    
    Parameters:
    
    configurationStateId - An identifier that indicates the ordering of the configuration items of a resource.
  - getConfigurationStateId
```
public String getConfigurationStateId()
```
    An identifier that indicates the ordering of the configuration items of a resource.
    
    Returns:
    
    An identifier that indicates the ordering of the configuration items of a resource.
  - withConfigurationStateId
```
public BaseConfigurationItem withConfigurationStateId(String configurationStateId)
```
    An identifier that indicates the ordering of the configuration items of a resource.
    
    Parameters:
    
    configurationStateId - An identifier that indicates the ordering of the configuration items of a resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the resource.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the resource.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the resource.
  - withArn
```
public BaseConfigurationItem withArn(String arn)
```
    The Amazon Resource Name (ARN) of the resource.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The type of Amazon Web Services resource.
    
    Parameters:
    
    resourceType - The type of Amazon Web Services resource.
    
    See Also:
    
    ResourceType
  - getResourceType
```
public String getResourceType()
```
    The type of Amazon Web Services resource.
    
    Returns:
    
    The type of Amazon Web Services resource.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public BaseConfigurationItem withResourceType(String resourceType)
```
    The type of Amazon Web Services resource.
    
    Parameters:
    
    resourceType - The type of Amazon Web Services resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public BaseConfigurationItem withResourceType(ResourceType resourceType)
```
    The type of Amazon Web Services resource.
    
    Parameters:
    
    resourceType - The type of Amazon Web Services resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setResourceId
```
public void setResourceId(String resourceId)
```
    The ID of the resource (for example., sg-xxxxxx).
    
    Parameters:
    
    resourceId - The ID of the resource (for example., sg-xxxxxx).
  - getResourceId
```
public String getResourceId()
```
    The ID of the resource (for example., sg-xxxxxx).
    
    Returns:
    
    The ID of the resource (for example., sg-xxxxxx).
  - withResourceId
```
public BaseConfigurationItem withResourceId(String resourceId)
```
    The ID of the resource (for example., sg-xxxxxx).
    
    Parameters:
    
    resourceId - The ID of the resource (for example., sg-xxxxxx).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceName
```
public void setResourceName(String resourceName)
```
    The custom name of the resource, if available.
    
    Parameters:
    
    resourceName - The custom name of the resource, if available.
  - getResourceName
```
public String getResourceName()
```
    The custom name of the resource, if available.
    
    Returns:
    
    The custom name of the resource, if available.
  - withResourceName
```
public BaseConfigurationItem withResourceName(String resourceName)
```
    The custom name of the resource, if available.
    
    Parameters:
    
    resourceName - The custom name of the resource, if available.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAwsRegion
```
public void setAwsRegion(String awsRegion)
```
    The region where the resource resides.
    
    Parameters:
    
    awsRegion - The region where the resource resides.
  - getAwsRegion
```
public String getAwsRegion()
```
    The region where the resource resides.
    
    Returns:
    
    The region where the resource resides.
  - withAwsRegion
```
public BaseConfigurationItem withAwsRegion(String awsRegion)
```
    The region where the resource resides.
    
    Parameters:
    
    awsRegion - The region where the resource resides.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    The Availability Zone associated with the resource.
    
    Parameters:
    
    availabilityZone - The Availability Zone associated with the resource.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    The Availability Zone associated with the resource.
    
    Returns:
    
    The Availability Zone associated with the resource.
  - withAvailabilityZone
```
public BaseConfigurationItem withAvailabilityZone(String availabilityZone)
```
    The Availability Zone associated with the resource.
    
    Parameters:
    
    availabilityZone - The Availability Zone associated with the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceCreationTime
```
public void setResourceCreationTime(Date resourceCreationTime)
```
    The time stamp when the resource was created.
    
    Parameters:
    
    resourceCreationTime - The time stamp when the resource was created.
  - getResourceCreationTime
```
public Date getResourceCreationTime()
```
    The time stamp when the resource was created.
    
    Returns:
    
    The time stamp when the resource was created.
  - withResourceCreationTime
```
public BaseConfigurationItem withResourceCreationTime(Date resourceCreationTime)
```
    The time stamp when the resource was created.
    
    Parameters:
    
    resourceCreationTime - The time stamp when the resource was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfiguration
```
public void setConfiguration(String configuration)
```
    The description of the resource configuration.
    
    Parameters:
    
    configuration - The description of the resource configuration.
  - getConfiguration
```
public String getConfiguration()
```
    The description of the resource configuration.
    
    Returns:
    
    The description of the resource configuration.
  - withConfiguration
```
public BaseConfigurationItem withConfiguration(String configuration)
```
    The description of the resource configuration.
    
    Parameters:
    
    configuration - The description of the resource configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSupplementaryConfiguration
```
public Map<String,String> getSupplementaryConfiguration()
```
    Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
    
    Returns:
    
    Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
  - setSupplementaryConfiguration
```
public void setSupplementaryConfiguration(Map<String,String> supplementaryConfiguration)
```
    Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
    
    Parameters:
    
    supplementaryConfiguration - Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
  - withSupplementaryConfiguration
```
public BaseConfigurationItem withSupplementaryConfiguration(Map<String,String> supplementaryConfiguration)
```
    Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
    
    Parameters:
    
    supplementaryConfiguration - Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSupplementaryConfigurationEntry
```
public BaseConfigurationItem addSupplementaryConfigurationEntry(String key,
                                                                String value)
```
    Add a single SupplementaryConfiguration entry
    
    See Also:
    
    withSupplementaryConfiguration(java.util.Map<java.lang.String, java.lang.String>)
  - clearSupplementaryConfigurationEntries
```
public BaseConfigurationItem clearSupplementaryConfigurationEntries()
```
    Removes all the entries added into SupplementaryConfiguration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BaseConfigurationItem clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BaseConfigurationItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseConfigurationItem

Method Detail

setVersion

getVersion

withVersion

setAccountId

getAccountId

withAccountId

setConfigurationItemCaptureTime

getConfigurationItemCaptureTime

withConfigurationItemCaptureTime

setConfigurationItemStatus

getConfigurationItemStatus

withConfigurationItemStatus

withConfigurationItemStatus

setConfigurationStateId

getConfigurationStateId

withConfigurationStateId

setArn

getArn

withArn

setResourceType

getResourceType

withResourceType

withResourceType

setResourceId

getResourceId

withResourceId

setResourceName

getResourceName

withResourceName

setAwsRegion

getAwsRegion

withAwsRegion

setAvailabilityZone

getAvailabilityZone

withAvailabilityZone

setResourceCreationTime

getResourceCreationTime

withResourceCreationTime

setConfiguration

getConfiguration

withConfiguration

getSupplementaryConfiguration

setSupplementaryConfiguration

withSupplementaryConfiguration

addSupplementaryConfigurationEntry

clearSupplementaryConfigurationEntries

toString

equals

hashCode

clone

marshall