CfnConnectorV2

class aws_cdk.aws_securityhub.CfnConnectorV2(scope, id, *, name, provider, description=None, kms_key_arn=None, tags=None)

Bases: CfnResource

Grants permission to create a connectorV2 based on input parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-connectorv2.html

CloudformationResource:

AWS::SecurityHub::ConnectorV2

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_securityhub as securityhub

cfn_connector_v2 = securityhub.CfnConnectorV2(self, "MyCfnConnectorV2",
    name="name",
    provider=securityhub.CfnConnectorV2.ProviderProperty(
        jira_cloud=securityhub.CfnConnectorV2.JiraCloudProperty(
            project_key="projectKey",

            # the properties below are optional
            auth_status="authStatus",
            auth_url="authUrl",
            cloud_id="cloudId",
            domain="domain"
        ),
        service_now=securityhub.CfnConnectorV2.ServiceNowProperty(
            instance_name="instanceName",
            secret_arn="secretArn",

            # the properties below are optional
            auth_status="authStatus"
        )
    ),

    # the properties below are optional
    description="description",
    kms_key_arn="kmsKeyArn",
    tags={
        "tags_key": "tags"
    }
)

Create a new AWS::SecurityHub::ConnectorV2.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • name (str) – The unique name of the connectorV2.

  • provider (Union[IResolvable, ProviderProperty, Dict[str, Any]]) – The third-party provider detail for a service configuration.

  • description (Optional[str]) – The description of the connectorV2.

  • kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) of KMS key used to encrypt secrets for the connectorV2.

  • tags (Optional[Mapping[str, str]]) – The tags to add to the connectorV2 when you create.

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)

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.

Parameters:

target (CfnResource)

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.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

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

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

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 addPropertyOverride or prefix path with “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 value argument to addOverride will 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

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: true

  • default (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:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

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:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

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 this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[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)

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:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SecurityHub::ConnectorV2'
attr_connector_arn

The ARN of the V2 connector.

CloudformationAttribute:

ConnectorArn

attr_connector_id

The unique identifier of the V2 connector.

CloudformationAttribute:

ConnectorId

attr_connector_status

The status of the V2 connector.

CloudformationAttribute:

ConnectorStatus

attr_created_at

The timestamp when the V2 connector was created.

CloudformationAttribute:

CreatedAt

attr_last_checked_at

The most recent timestamp when the V2 connector was checked on health status.

CloudformationAttribute:

LastCheckedAt

attr_last_updated_at

The most recent timestamp when the V2 connector was updated.

CloudformationAttribute:

LastUpdatedAt

attr_message

The message of the V2 connector when connector status is FAILED_TO_CONNECT.

CloudformationAttribute:

Message

attr_provider_jira_cloud_auth_status

The status of the authorization between Jira Cloud and the service.

CloudformationAttribute:

Provider.JiraCloud.AuthStatus

attr_provider_jira_cloud_auth_url

The URL to provide to customers for OAuth auth code flow.

CloudformationAttribute:

Provider.JiraCloud.AuthUrl

attr_provider_jira_cloud_cloud_id

The cloud id of the Jira Cloud.

CloudformationAttribute:

Provider.JiraCloud.CloudId

attr_provider_jira_cloud_domain

The URL domain of your Jira Cloud instance.

CloudformationAttribute:

Provider.JiraCloud.Domain

attr_provider_service_now_auth_status

The status of the authorization between ServiceNow and the service.

CloudformationAttribute:

Provider.ServiceNow.AuthStatus

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_v2_ref

A reference to a ConnectorV2 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

The description of the connectorV2.

env
kms_key_arn

The Amazon Resource Name (ARN) of KMS key used to encrypt secrets for the connectorV2.

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

The unique name of the connectorV2.

node

The tree node.

provider

The third-party provider detail for a service 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

The tags to add to the connectorV2 when you create.

Static Methods

classmethod is_cfn_connector_v2(x)

Checks whether the given object is a CfnConnectorV2.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to 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 x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

JiraCloudProperty

class CfnConnectorV2.JiraCloudProperty(*, project_key, auth_status=None, auth_url=None, cloud_id=None, domain=None)

Bases: object

Information about the configuration and status of a Jira Cloud integration.

Parameters:

  • project_key (str) – The projectKey of Jira Cloud.

  • auth_status (Optional[str]) – The status of the authorization between Jira Cloud and the service.

  • auth_url (Optional[str]) – The URL to provide to customers for OAuth auth code flow.

  • cloud_id (Optional[str]) – The cloud id of the Jira Cloud.

  • domain (Optional[str]) – The URL domain of your Jira Cloud instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-jiracloud.html

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_securityhub as securityhub

jira_cloud_property = securityhub.CfnConnectorV2.JiraCloudProperty(
    project_key="projectKey",

    # the properties below are optional
    auth_status="authStatus",
    auth_url="authUrl",
    cloud_id="cloudId",
    domain="domain"
)

Attributes

auth_status

The status of the authorization between Jira Cloud and the service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-jiracloud.html#cfn-securityhub-connectorv2-jiracloud-authstatus

auth_url

The URL to provide to customers for OAuth auth code flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-jiracloud.html#cfn-securityhub-connectorv2-jiracloud-authurl

cloud_id

The cloud id of the Jira Cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-jiracloud.html#cfn-securityhub-connectorv2-jiracloud-cloudid

domain

The URL domain of your Jira Cloud instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-jiracloud.html#cfn-securityhub-connectorv2-jiracloud-domain

project_key

The projectKey of Jira Cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-jiracloud.html#cfn-securityhub-connectorv2-jiracloud-projectkey

ProviderProperty

class CfnConnectorV2.ProviderProperty(*, jira_cloud=None, service_now=None)

Bases: object

The third-party provider detail for a service configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-provider.html

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_securityhub as securityhub

provider_property = securityhub.CfnConnectorV2.ProviderProperty(
    jira_cloud=securityhub.CfnConnectorV2.JiraCloudProperty(
        project_key="projectKey",

        # the properties below are optional
        auth_status="authStatus",
        auth_url="authUrl",
        cloud_id="cloudId",
        domain="domain"
    ),
    service_now=securityhub.CfnConnectorV2.ServiceNowProperty(
        instance_name="instanceName",
        secret_arn="secretArn",

        # the properties below are optional
        auth_status="authStatus"
    )
)

Attributes

jira_cloud

Details about a Jira Cloud integration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-provider.html#cfn-securityhub-connectorv2-provider-jiracloud

service_now

Details about a ServiceNow ITSM integration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-provider.html#cfn-securityhub-connectorv2-provider-servicenow

ServiceNowProperty

class CfnConnectorV2.ServiceNowProperty(*, instance_name, secret_arn, auth_status=None)

Bases: object

Information about a ServiceNow ITSM integration.

Parameters:

  • instance_name (str) – The instanceName of ServiceNow ITSM.

  • secret_arn (str) – The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the ServiceNow credentials.

  • auth_status (Optional[str]) – The status of the authorization between ServiceNow and the service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-servicenow.html

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_securityhub as securityhub

service_now_property = securityhub.CfnConnectorV2.ServiceNowProperty(
    instance_name="instanceName",
    secret_arn="secretArn",

    # the properties below are optional
    auth_status="authStatus"
)

Attributes

auth_status

The status of the authorization between ServiceNow and the service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-servicenow.html#cfn-securityhub-connectorv2-servicenow-authstatus

instance_name

The instanceName of ServiceNow ITSM.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-servicenow.html#cfn-securityhub-connectorv2-servicenow-instancename

secret_arn

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the ServiceNow credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-servicenow.html#cfn-securityhub-connectorv2-servicenow-secretarn