Skip to content

update_odb_network

update_odb_network(
    odb_network_id: ResourceIdOrArn,
    *,
    config_overrides: Optional[odbClientConfig] = None,
    display_name: Optional[ResourceDisplayName] = None,
    peered_cidrs_to_be_added: Optional[StringList] = None,
    peered_cidrs_to_be_removed: Optional[StringList] = None,
    s3_access: Optional[Access] = None,
    zero_etl_access: Optional[Access] = None,
    sts_access: Optional[Access] = None,
    kms_access: Optional[Access] = None,
    s3_policy_document: Optional[PolicyDocument] = None,
    sts_policy_document: Optional[PolicyDocument] = None,
    kms_policy_document: Optional[PolicyDocument] = None,
    cross_region_s3_restore_sources_to_enable: Optional[StringList] = None,
    cross_region_s3_restore_sources_to_disable: Optional[StringList] = None,
) -> UpdateOdbNetworkOutput

Updates properties of a specified ODB network.

Parameters:

  • odb_network_id (ResourceIdOrArn) –

    The unique identifier of the ODB network to update.

  • display_name (Optional[ResourceDisplayName], default: None ) –

    The new user-friendly name of the ODB network.

  • peered_cidrs_to_be_added (Optional[StringList], default: None ) –

    The list of CIDR ranges from the peered VPC that allow access to the ODB network.

  • peered_cidrs_to_be_removed (Optional[StringList], default: None ) –

    The list of CIDR ranges from the peered VPC to remove from the ODB network.

  • s3_access (Optional[Access], default: None ) –

    Specifies the updated configuration for Amazon S3 access from the ODB network.

  • zero_etl_access (Optional[Access], default: None ) –

    Specifies the updated configuration for Zero-ETL access from the ODB network.

  • sts_access (Optional[Access], default: None ) –

    The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.

  • kms_access (Optional[Access], default: None ) –

    The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.

  • s3_policy_document (Optional[PolicyDocument], default: None ) –

    Specifies the updated endpoint policy for Amazon S3 access from the ODB network.

  • sts_policy_document (Optional[PolicyDocument], default: None ) –

    The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.

  • kms_policy_document (Optional[PolicyDocument], default: None ) –

    The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.

  • cross_region_s3_restore_sources_to_enable (Optional[StringList], default: None ) –

    The cross-Region Amazon S3 restore sources to enable for the ODB network.

  • cross_region_s3_restore_sources_to_disable (Optional[StringList], default: None ) –

    The cross-Region Amazon S3 restore sources to disable for the ODB network.

Raises:

  • AccessDeniedException –

    You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

  • ConflictException –

    Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

  • InternalServerException –

    Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

  • ResourceNotFoundException –

    The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The request has failed validation because it is missing required fields or has invalid inputs.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_odb/_services/odb.py
def update_odb_network(
    self,
    odb_network_id: "capo_odb.types.resource_id_or_arn.ResourceIdOrArn",
    *,
    config_overrides: Optional[odbClientConfig] = None,
    display_name: Optional[
        "capo_odb.types.resource_display_name.ResourceDisplayName"
    ] = None,
    peered_cidrs_to_be_added: Optional[
        "capo_odb.types.string_list.StringList"
    ] = None,
    peered_cidrs_to_be_removed: Optional[
        "capo_odb.types.string_list.StringList"
    ] = None,
    s3_access: Optional["capo_odb.types.access.Access"] = None,
    zero_etl_access: Optional["capo_odb.types.access.Access"] = None,
    sts_access: Optional["capo_odb.types.access.Access"] = None,
    kms_access: Optional["capo_odb.types.access.Access"] = None,
    s3_policy_document: Optional[
        "capo_odb.types.policy_document.PolicyDocument"
    ] = None,
    sts_policy_document: Optional[
        "capo_odb.types.policy_document.PolicyDocument"
    ] = None,
    kms_policy_document: Optional[
        "capo_odb.types.policy_document.PolicyDocument"
    ] = None,
    cross_region_s3_restore_sources_to_enable: Optional[
        "capo_odb.types.string_list.StringList"
    ] = None,
    cross_region_s3_restore_sources_to_disable: Optional[
        "capo_odb.types.string_list.StringList"
    ] = None,
) -> "capo_odb.types.update_odb_network_output.UpdateOdbNetworkOutput":
    """<p>Updates properties of a specified ODB network.</p>

    Args:
        odb_network_id: <p>The unique identifier of the ODB network to update.</p>
        display_name: <p>The new user-friendly name of the ODB network.</p>
        peered_cidrs_to_be_added: <p>The list of CIDR ranges from the peered VPC that allow access to the ODB network.</p>
        peered_cidrs_to_be_removed: <p>The list of CIDR ranges from the peered VPC to remove from the ODB network.</p>
        s3_access: <p>Specifies the updated configuration for Amazon S3 access from the ODB network.</p>
        zero_etl_access: <p>Specifies the updated configuration for Zero-ETL access from the ODB network.</p>
        sts_access: <p>The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.</p>
        kms_access: <p>The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.</p>
        s3_policy_document: <p>Specifies the updated endpoint policy for Amazon S3 access from the ODB network.</p>
        sts_policy_document: <p>The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.</p>
        kms_policy_document: <p>The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.</p>
        cross_region_s3_restore_sources_to_enable: <p>The cross-Region Amazon S3 restore sources to enable for the ODB network.</p>
        cross_region_s3_restore_sources_to_disable: <p>The cross-Region Amazon S3 restore sources to disable for the ODB network.</p>

    Raises:
        capo_odb.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.</p>
        capo_odb.errors.conflict_exception.ConflictException: <p>Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.</p>
        capo_odb.errors.internal_server_exception.InternalServerException: <p>Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.</p>
        capo_odb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.</p>
        capo_odb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_odb.errors.validation_exception.ValidationException: <p>The request has failed validation because it is missing required fields or has invalid inputs.</p>
        capo_odb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_odb.types.update_odb_network_input.UpdateOdbNetworkInput]",
    ) -> OperationResponse[
        "capo_odb.types.update_odb_network_output.UpdateOdbNetworkOutput"
    ]:
        import capo_odb._operations.odb.update_odb_network

        output, http_response = (
            capo_odb._operations.odb.update_odb_network.update_odb_network(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateOdbNetwork")
    )
    input_: capo_odb.types.update_odb_network_input.UpdateOdbNetworkInput = {
        "odb_network_id": odb_network_id
    }
    if display_name is not None:
        input_["display_name"] = display_name
    if peered_cidrs_to_be_added is not None:
        input_["peered_cidrs_to_be_added"] = peered_cidrs_to_be_added
    if peered_cidrs_to_be_removed is not None:
        input_["peered_cidrs_to_be_removed"] = peered_cidrs_to_be_removed
    if s3_access is not None:
        input_["s3_access"] = s3_access
    if zero_etl_access is not None:
        input_["zero_etl_access"] = zero_etl_access
    if sts_access is not None:
        input_["sts_access"] = sts_access
    if kms_access is not None:
        input_["kms_access"] = kms_access
    if s3_policy_document is not None:
        input_["s3_policy_document"] = s3_policy_document
    if sts_policy_document is not None:
        input_["sts_policy_document"] = sts_policy_document
    if kms_policy_document is not None:
        input_["kms_policy_document"] = kms_policy_document
    if cross_region_s3_restore_sources_to_enable is not None:
        input_["cross_region_s3_restore_sources_to_enable"] = (
            cross_region_s3_restore_sources_to_enable
        )
    if cross_region_s3_restore_sources_to_disable is not None:
        input_["cross_region_s3_restore_sources_to_disable"] = (
            cross_region_s3_restore_sources_to_disable
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output