CfnConnector
- class aws_cdk.aws_inspectorv2.CfnConnector(scope, id, *, name, provider, provider_configuration, description=None, tags=None)
Bases:
CfnResourceCreates and manages a multi-cloud connector for Amazon Inspector, enabling vulnerability scanning of Azure resources.
- See:
- CloudformationResource:
AWS::InspectorV2::Connector
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_inspectorv2 as inspectorv2 cfn_connector = inspectorv2.CfnConnector(self, "MyCfnConnector", name="name", provider="provider", provider_configuration=inspectorv2.CfnConnector.ProviderConfigurationProperty( azure=inspectorv2.CfnConnector.AzureProviderConfigurationProperty( aws_config_connector_arn="awsConfigConnectorArn", azure_regions=["azureRegions"], scope_configuration=inspectorv2.CfnConnector.AzureScopeConfigurationMapProperty( container_image_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ), serverless_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ), vm_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ) ), # the properties below are optional auto_install_vm_scanner=False ) ), # the properties below are optional description="description", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::InspectorV2::Connector.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).name (
str) – Display name for the connector.provider (
str)provider_configuration (
Union[IResolvable,ProviderConfigurationProperty,Dict[str,Any]])description (
Optional[str]) – Optional description of the connector.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – Tags to apply to the connector.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This method has been renamed to
addResourceDependencyto more clearly set it apart fromconstruct.node.addDependency. See the documentation of that function for more details.- Parameters:
target (
CfnResource)- Deprecated:
Use
addResourceDependencyinstead.- Stability:
deprecated
- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to
addResourceDependency, which makes it more clear that this method operates at a different level from the construct-levelconstruct.node.addDependency()mechanism.- Parameters:
target (
CfnResource)- Deprecated:
Use
addResourceDependencyinstead.- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- add_resource_dependency(target, reason=None)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use
construct.node.addDependencyinstead.- Parameters:
target (
CfnResource)reason (
Optional[str])
- Return type:
None
- apply_cross_stack_reference_strength(strength)
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.
- Parameters:
strength (
ReferenceStrength) –The reference strength to use for this resource.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- cfn_property_name(cdk_property_name)
- Parameters:
cdk_property_name (
str)- Return type:
Optional[str]
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the
CfnResourceobject. For dependencies on other stacks, returns theStackobject. The order of the array is not guaranteed.- Return type:
List[Union[Stack,CfnResource]]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
(deprecated) Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Deprecated:
Use
removeResourceDependencyinstead- Stability:
deprecated
- Return type:
None
- remove_resource_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
- with_(*mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple
with()calls if subsequent mixins should apply to added constructs.- Parameters:
mixins (
IMixin)- Return type:
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::InspectorV2::Connector'
- attr_connector_arn
The Amazon Resource Name (ARN) of the connector.
- CloudformationAttribute:
ConnectorArn
- attr_created_at
Timestamp when the connector was created.
- CloudformationAttribute:
CreatedAt
- attr_enablement_status
EnablementStatus
- Type:
cloudformationAttribute
- attr_enablement_status_reason
Reason for the current enablement status, if applicable.
- CloudformationAttribute:
EnablementStatusReason
- attr_health
Health
- Type:
cloudformationAttribute
- attr_last_updated_at
Timestamp when the connector was last updated.
- CloudformationAttribute:
LastUpdatedAt
- attr_provider_configuration_azure_scope_configuration_container_image_scanning_state
ProviderConfiguration.Azure.ScopeConfiguration.ContainerImageScanning.State
- Type:
cloudformationAttribute
- attr_provider_configuration_azure_scope_configuration_container_image_scanning_state_reason
Reason for the current scope state.
- CloudformationAttribute:
ProviderConfiguration.Azure.ScopeConfiguration.ContainerImageScanning.StateReason
- attr_provider_configuration_azure_scope_configuration_serverless_scanning_state
ProviderConfiguration.Azure.ScopeConfiguration.ServerlessScanning.State
- Type:
cloudformationAttribute
- attr_provider_configuration_azure_scope_configuration_serverless_scanning_state_reason
Reason for the current scope state.
- CloudformationAttribute:
ProviderConfiguration.Azure.ScopeConfiguration.ServerlessScanning.StateReason
- attr_provider_configuration_azure_scope_configuration_vm_scanning_state
ProviderConfiguration.Azure.ScopeConfiguration.VmScanning.State
- Type:
cloudformationAttribute
- attr_provider_configuration_azure_scope_configuration_vm_scanning_state_reason
Reason for the current scope state.
- CloudformationAttribute:
ProviderConfiguration.Azure.ScopeConfiguration.VmScanning.StateReason
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- connector_ref
A reference to a Connector resource.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
Optional description of the connector.
- env
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
Display name for the connector.
- node
The tree node.
- provider
- provider_configuration
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tags to apply to the connector.
Static Methods
- classmethod arn_for_connector(resource)
- Parameters:
resource (
IConnectorRef)- Return type:
str
- classmethod is_cfn_connector(x)
Checks whether the given object is a CfnConnector.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
AzureProviderConfigurationProperty
- class CfnConnector.AzureProviderConfigurationProperty(*, aws_config_connector_arn, azure_regions, scope_configuration, auto_install_vm_scanner=None)
Bases:
object- Parameters:
aws_config_connector_arn (
str) – The ARN of the AWS Config connector used for Azure resource discovery.azure_regions (
Sequence[str]) – List of Azure regions to scan.scope_configuration (
Union[IResolvable,AzureScopeConfigurationMapProperty,Dict[str,Any]]) – Defines which resource types to scan and at what scope level.auto_install_vm_scanner (
Union[bool,IResolvable,None]) – Whether to automatically install the VM scanner. Defaults to true. Default: - true
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_inspectorv2 as inspectorv2 azure_provider_configuration_property = inspectorv2.CfnConnector.AzureProviderConfigurationProperty( aws_config_connector_arn="awsConfigConnectorArn", azure_regions=["azureRegions"], scope_configuration=inspectorv2.CfnConnector.AzureScopeConfigurationMapProperty( container_image_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ), serverless_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ), vm_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ) ), # the properties below are optional auto_install_vm_scanner=False )
Attributes
- auto_install_vm_scanner
Whether to automatically install the VM scanner.
Defaults to true.
- aws_config_connector_arn
The ARN of the AWS Config connector used for Azure resource discovery.
- azure_regions
List of Azure regions to scan.
- scope_configuration
Defines which resource types to scan and at what scope level.
AzureScopeConfigurationMapProperty
- class CfnConnector.AzureScopeConfigurationMapProperty(*, container_image_scanning=None, serverless_scanning=None, vm_scanning=None)
Bases:
objectDefines which resource types to scan and at what scope level.
- Parameters:
container_image_scanning (
Union[IResolvable,ScopeConfigurationProperty,Dict[str,Any],None]) – Defines the scope of Azure resources to monitor for a specific resource type.serverless_scanning (
Union[IResolvable,ScopeConfigurationProperty,Dict[str,Any],None]) – Defines the scope of Azure resources to monitor for a specific resource type.vm_scanning (
Union[IResolvable,ScopeConfigurationProperty,Dict[str,Any],None]) – Defines the scope of Azure resources to monitor for a specific resource type.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_inspectorv2 as inspectorv2 azure_scope_configuration_map_property = inspectorv2.CfnConnector.AzureScopeConfigurationMapProperty( container_image_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ), serverless_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ), vm_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ) )
Attributes
- container_image_scanning
Defines the scope of Azure resources to monitor for a specific resource type.
- serverless_scanning
Defines the scope of Azure resources to monitor for a specific resource type.
- vm_scanning
Defines the scope of Azure resources to monitor for a specific resource type.
ConnectorHealthProperty
- class CfnConnector.ConnectorHealthProperty(*, connector_status=None, last_checked_at=None, message=None)
Bases:
object- Parameters:
connector_status (
Optional[str])last_checked_at (
Optional[str])message (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_inspectorv2 as inspectorv2 connector_health_property = inspectorv2.CfnConnector.ConnectorHealthProperty( connector_status="connectorStatus", last_checked_at="lastCheckedAt", message="message" )
Attributes
- connector_status
-
- Type:
see
- last_checked_at
-
- Type:
see
ProviderConfigurationProperty
- class CfnConnector.ProviderConfigurationProperty(*, azure)
Bases:
object- Parameters:
azure (
Union[IResolvable,AzureProviderConfigurationProperty,Dict[str,Any]])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_inspectorv2 as inspectorv2 provider_configuration_property = inspectorv2.CfnConnector.ProviderConfigurationProperty( azure=inspectorv2.CfnConnector.AzureProviderConfigurationProperty( aws_config_connector_arn="awsConfigConnectorArn", azure_regions=["azureRegions"], scope_configuration=inspectorv2.CfnConnector.AzureScopeConfigurationMapProperty( container_image_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ), serverless_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ), vm_scanning=inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" ) ), # the properties below are optional auto_install_vm_scanner=False ) )
Attributes
ScopeConfigurationProperty
- class CfnConnector.ScopeConfigurationProperty(*, scope_type, scope_values=None, state=None, state_reason=None)
Bases:
objectDefines the scope of Azure resources to monitor for a specific resource type.
- Parameters:
scope_type (
str)scope_values (
Optional[Sequence[str]]) – List of subscription IDs. Empty for TENANT scope.state (
Optional[str])state_reason (
Optional[str]) – Reason for the current scope state.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_inspectorv2 as inspectorv2 scope_configuration_property = inspectorv2.CfnConnector.ScopeConfigurationProperty( scope_type="scopeType", # the properties below are optional scope_values=["scopeValues"], state="state", state_reason="stateReason" )
Attributes
- scope_type
-
- Type:
see
- scope_values
List of subscription IDs.
Empty for TENANT scope.
- state
-
- Type:
see
- state_reason
Reason for the current scope state.